GET /api/v1/number_order_prefixes
List Number Order Prefix records.

Params

Param name
Description
ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.

created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

fulltext
Optional

Search for any record that matches this text

  • Must be String

time_zone
Optional

Date ranges will be parsed using this time zone.

columns
Optional
Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • number_order_id
  • prefix
  • order_count
  • numbers_statuses
  • number_ids
  • sortable_order
  • Must be String

root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off


GET /api/v1/number_order_prefixes/new
Build Number Order Prefix with defaults.

Params

Param name
Description
number_order_id
Optional Blank Value Allowed

Number Order

prefix
Optional Blank Value Allowed

Prefix

  • Must be String

order_count
Optional Blank Value Allowed

Order Count

  • Must be a decimal number.

sortable_order
Optional Blank Value Allowed

Sortable Order

  • Must be a decimal number.


POST /api/v1/number_order_prefixes
Create Number Order Prefix.

Params

Param name
Description
number_order_id
Optional Blank Value Allowed

Number Order

prefix
Optional Blank Value Allowed

Prefix

  • Must be String

order_count
Optional Blank Value Allowed

Order Count

  • Must be a decimal number.

sortable_order
Optional Blank Value Allowed

Sortable Order

  • Must be a decimal number.


GET /api/v1/number_order_prefixes/:id
Get Number Order Prefix by id.


PUT /api/v1/number_order_prefixes/:id
Update Number Order Prefix by id.

Params

Param name
Description
number_order_id
Optional Blank Value Allowed

Number Order

prefix
Optional Blank Value Allowed

Prefix

  • Must be String

order_count
Optional Blank Value Allowed

Order Count

  • Must be a decimal number.

sortable_order
Optional Blank Value Allowed

Sortable Order

  • Must be a decimal number.


DELETE /api/v1/number_order_prefixes/:id
Destroy Number Order Prefix by id.