RErev-io
Services

View service

Changed on

Find a single service by ID.

get/v1/Services/{id}

Request

Path parameters

idinteger required

ID of the service to view.

Response

OK

okboolean
status_userinteger

The user id of the user who made the most recent status change

status_datestring date-time

The date of the most recent service status change

service_idinteger

Primary identifier for this service. Do not include when creating a new service.

customer_idinteger

Foreign identifier indicating the account it belongs to.

provider_idinteger

Foreign identifier indicating the underlying provider of service.

service_type_idinteger

Foreign identifier indicating the type of service delivered.

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).

picstring

Primary Interexchange Carrier code - indicates long distance service provider.

lpicstring

Local Primary Interexchange Carrier code - indicates local service provider.

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.

number2string

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

descriptionstring

Short description of the service.

disconnected_datestring date-time

Date and time service was disconnected. In order to update the disconnected date, all service products under this service need to already have the same disconnected date as the new disconnected date for this service.

activated_datestring date-time

Date and time service was activated. In order to update the activated date, all service products under this service need to already have the same activated date as the new activated date for this service.

address_idinteger

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

addressz_idinteger

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

provider_account_numberstring

Secondary identifier for the service, provider-side.

contract_startstring date-time

Date service contract starts.

contract_endstring date-time

Date service contract ends.

created_datestring date-time

Date and time this service was added to the request.

hunt_groupstring

Group number used to route calls to multiple members

circuit_number2string

Secondary network-level identifier, provider-side.

circuit_foc_datestring date-time

Date of Circuit Firm Order Commitment.

notesstring

User defined notes.

location_routing_numberstring

User defined location routing number.

request_service_idinteger

Foreign identifier indicating the request service that was responsible for creating this service.

status'PENDING' | 'ACTIVE' | 'DENIED' | 'DISCONNECTED'

Current status of the service.

Changes

  • f175f5a3b11dRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type text/html for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • breaking

      the response property's maxLength was unset from 255 for the response status (media type: application/json)

    • breaking

      the response property's maxLength was unset from 255 for the response status (media type: text/json)

    • breaking

      the response property's maxLength was unset from 255 for the response status (media type: text/html)

    • warning

      added the new ACTIVE enum value to the response property for the response status (media type: application/json)

    • warning

      added the new ACTIVE enum value to the response property for the response status (media type: text/json)

    • warning

      added the new ACTIVE enum value to the response property for the response status (media type: text/html)

    • warning

      added the new DENIED enum value to the response property for the response status (media type: application/json)

    • warning

      added the new DENIED enum value to the response property for the response status (media type: text/json)

    • warning

      added the new DENIED enum value to the response property for the response status (media type: text/html)

    • warning

      added the new DISCONNECTED enum value to the response property for the response status (media type: application/json)

    • warning

      added the new DISCONNECTED enum value to the response property for the response status (media type: text/json)

    • warning

      added the new DISCONNECTED enum value to the response property for the response status (media type: text/html)

    • warning

      added the new PENDING enum value to the response property for the response status (media type: application/json)

    • warning

      added the new PENDING enum value to the response property for the response status (media type: text/json)

    • warning

      added the new PENDING enum value to the response property for the response status (media type: text/html)