Sign in
Rule

Read

Retrieve a single Rule record by ID.

get/api/cp/rule/{id}

Path parameters

idinteger required

Id identifier

Response

Successful response

idinteger

Id

rev_idinteger

Rev Id

prefixstring

Prefix

namestring

Name

costnumber

Cost

intranumber

Intra

internumber

Inter

peaknumber

Peak

eveningnumber

Evening

weekendnumber

Weekend

mcdinteger

Mcd

pulseinteger

Pulse

rate_connectnumber

Rate Connect

date_livestring date-time

Date Live

statusstring

Status

lcr_jsonstring

Lcr Json

cost_lcrstring

Cost Lcr

intra_lcrstring

Intra Lcr

inter_lcrstring

Inter Lcr

peak_lcrstring

Peak Lcr

evening_lcrstring

Evening Lcr

weekend_lcrstring

Weekend Lcr

Example response

{
  "id": 12345,
  "rev_id": 1,
  "prefix": "example_prefix",
  "name": "Example Name",
  "cost": 99.99,
  "intra": 99.99,
  "inter": 99.99,
  "peak": 99.99,
  "evening": 99.99,
  "weekend": 99.99,
  "mcd": 100,
  "pulse": 100,
  "rate_connect": 99.99,
  "date_live": "2025-01-17T10:30:00Z",
  "status": "Active",
  "lcr_json": "Sample lcr_json text content",
  "cost_lcr": 99.99,
  "intra_lcr": "example_intra_lcr",
  "inter_lcr": "example_inter_lcr",
  "peak_lcr": "example_peak_lcr",
  "evening_lcr": "example_evening_lcr",
  "weekend_lcr": "example_weekend_lcr"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.