Retrieve all Service Numbers

Retrieve all Service Number from the client account

URL

GET {baseUrl}/serviceNumbers

Parameters

None

Response

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

A JSON Structure containing the following fields

Example

Note, the record array has been shortened for readability.

{
    "filter": "",
    "limitStart": 0,
    "limitPageSize": -1,
    "records": [
        {
            "ContractNumber": null,
            "dtTo": null,
            "EndNumber": "",
            "dtReset": "2022-05-05T12:09:53.878+02:00",
            "ResellerTrafficManagementPoliciesID": null,
            ...
            "ClientsID": 378,
            "ApplySeconds3": null,
            "ResellersID": 1
        },
        {
            "ContractNumber": null,
            "dtTo": null,
            "EndNumber": "",
            "dtReset": "2022-05-05T14:11:02.728+02:00",
            "ResellerTrafficManagementPoliciesID": null,
            ...
            "ClientsID": 378,
            "ApplySeconds3": null,
            "ResellersID": 1
        }
    ],
    "count": 2,
    "orderBy": "Name2",
    "ascending": true,
    "status": 200
}

Retrieve a specific Service Number by ID

Retrieve a specific Service Number by its ID.

URL

GET {baseUrl}/serviceNumbers/serviceNumber/:id

Parameters

:id: the ID of the Service Number.

Response

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

A JSON Structure containing the following fields

Example

Note, the record array has been shortened for readability.

{
    "records": [
        {
            "ContractNumber": null,
            "dtTo": null,
            "EndNumber": "",
            "dtReset": "2022-05-05T12:09:53.878+02:00",
            "ResellerTrafficManagementPoliciesID": null,
            ...
            "ClientsID": 378,
            "ApplySeconds3": null,
            "ResellersID": 1
        }
    ],
    "count": 1,
    "status": 200
}

Retrieve a specific Service Number by Name

Retrieve a specific Service Number by its Name.

URL

GET {baseUrl}/serviceNumbers/serviceNumber?name=$name

Parameters

$name: the Name of the Service Number.

Response

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

A JSON Structure containing the following fields

Example

Note, the record array has been shortened for readability.

{
    "records": [
        {
            "ContractNumber": null,
            "dtTo": null,
            "EndNumber": "",
            "dtReset": "2022-05-05T12:09:53.878+02:00",
            "ResellerTrafficManagementPoliciesID": null,
            ...
            "ClientsID": 378,
            "ApplySeconds3": null,
            "ResellersID": 1
        }
    ],
    "count": 1,
    "status": 200
}
  • No labels