v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
RequestServices

View request service

Find a single request service by ID.

get/v1/RequestServices/{id}

Path parameters

idinteger required

Format - int32. ID of the request service to view.

Response

OK

okboolean
request_service_idinteger

Primary identifier for this request service.

request_address_idinteger required

Foreign identifier indicating address service is delivered to, if different from account.

request_addressz_idinteger

Foreign identifier indicating address of opposite end of a connection (as with a point to point).

request_idinteger required

Foreign identifier indicating which request this is on.

service_type_idinteger required

Foreign identifier indicating the type of service delivered.

provider_idinteger required

Foreign identifier indicating the underlying provider of service.

provider_account_idinteger

Foreign identifier indicating which account, on the provider's system, to use.

usage_plan_group_idinteger

Foreign identifier indicating a group of rating rules to apply to usage.

package_idinteger

Foreign identifier indicating the package of products applied to the service.

numberstring

An identifier for the service, provider-side (i.e. TN, IP, Account ID).

number2string

A network-level identifier, provider-side (i.e. Circuit ID).

provider_account_numberstring

Secondary identifier for the service, provider-side.

descriptionstring

Short description of the service.

created_datestring date-time

Date and time this service was added to the request.

created_byinteger

Foreign identifier indicating which user added the service to the request.

contract_startstring date-time

Date service contract starts.

contract_endstring date-time

Date service contract ends.

picstring

Primary Interexchange Carrier code - indicates long distance service provider.

lpicstring

Local Primary Interexchange Carrier code - indicates local service provider.

order_type'NOT_SPECIFIED' | 'ADD_LINE' | 'CHANGE_FEATURE' | 'CHANGE_LISTING' | 'CHANGE_TN' | 'CONVERSION' | 'DENY' | 'DISCONNECT' | 'LD_BLOCK' | 'LD_RESTORE' | 'MIGRATION' | 'MIGRATION_UNEL' | 'NEW' | 'PORT' | 'REFRESH' | 'RESTORE' | 'SUSPEND' | 'TRANSFER' | 'CNAM' | 'E911' | 'FIBER_CONVERSION'

Indicates whether a New or Conversion order should be produced for this service. Allowed Values: NEW, CONVERSION