logo
API docs by Redocly

Service and Feature Management (2.37)

Download OpenAPI specification:Download

Service and Feature Management Concepts

The Service and Feature Management API is a RESTful endpoint that allows management of assigned services and their features, as well as features assigned at the customer level.

System Integrity

Resources related to system integrity.

Health Check

Use to check whether or not the Service And Feature Management API is up and running.

Authorizations:
SWT

Responses

Auxiliary Data

Read only resources that provide additional information related to services and features.

Search Phone Book Special Numbers

Get the phonebook special numbers in the system. [Rev 1.05]

Available Fields

The following is a list of field and how they can be used within a search.

  • Filterable: enabled, phoneBookSpecialNumber, phoneBookSpecialNumberID
  • Sortable: enabled, phoneBookSpecialNumber, phoneBookSpecialNumberID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Contract

Resources related to managing contracts (a specific type of Feature).

Calculate Contract Early Termination Fee (ETF)

Provides the ability to calculate an early termination fee (ETF) for a contract, if the contract were terminated on the specified date.

Note

  • The contract must have a Term Commitment term in order to calculate the fee.
  • The fee is calculated based off of the penalties configured for the Term Commitment term. The following penalty calculation types are supported:
    • Fixed Fee
    • Prorated Fee
path Parameters
id
required
integer
Example: 1

Unique identifier of the contract feature.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
date
required
string

A date-only string specifying the date based on which to calculate the early termination fee of this contract. The value returned from the calculation will be the penalty fee if the contract were terminated on this date. (Note that any time component of the parsed date will be ignored.)

Responses

Request samples

Content type
application/json
{
  • "date": "2020-05-27"
}

Response samples

Content type
application/json
{
  • "etf": 22.5
}

Coverage Service Area

Resources related to managing and checking coverage service areas.

List Coverage Types

List of the coverage service area coverage types in the system. [Rev 1.17]

Available Fields

The following is a list of fields for a coverage type and how they can be used within a search.

  • Filterable : No fields are filterable.
  • Sortable : No fields are sortable.
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Search Coverage Indicators

Search for Coverage Indicators in the system. [Rev 1.17]

Available Fields

The following is a list of fields for a service area coverage indicator and how they can be used within a search.

  • Filterable : coverageIndicatorID, coverageTypeID
  • Sortable : coverageIndicatorID, coverageIndicator, coverageTypeID, coverageType.
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Add Coverage Indicators

Add Coverage Indicators into the system. [Rev 1.17]

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
coverageIndicator
required
string

Coverage Indicator Name.

coverageTypeID
integer

Unique identifier for the coverage type.

Responses

Request samples

Content type
application/json
{
  • "coverageIndicator": "Victor Full Coverage",
  • "coverageTypeID": 7
}

Response samples

Content type
application/json
{
  • "coverageIndicator": "Not Available",
  • "coverageIndicatorID": 1000,
  • "coverageTypeID": 1000
}

Get a Coverage Indicator

Retrieve a specific coverage indicator by ID. [Rev 1.17]

Authorizations:
SWT
path Parameters
id
required
integer

Unique ID of the Device to retrieve.

Responses

Response samples

Content type
application/json
{
  • "coverageIndicator": "Not Available",
  • "coverageIndicatorID": 1000,
  • "coverageType": "No Coverage",
  • "coverageTypeID": 1000
}

Update a Coverage Indicator

Updates a specific coverage indicator by ID. [Rev 1.17]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a coverage indicator, which you can read more about here: JSON Patch (RFC 6902).

Patchable Fields

Allowed patch operations for each patchable property of a coverage indicator.

  • coverageIndicator : replace

  • coverageTypeID : add, remove, replace

Authorizations:
SWT
path Parameters
id
required
integer

Unique ID of the covergage indicator.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Search Coverage Areas

Search for Coverage Areas in the system. [Rev 1.17]

Available Fields

The following is a list of fields for a coverage service area and how they can be used within a search.

  • Filterable : coverageIndicatorID, regionID, zip
  • Sortable : coverageIndicator, coverageIndicatorID, csa, region, regionID, zip.
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Delete Coverage Areas

Remove a Coverage Area from the system. [Rev 1.17]

Authorizations:
SWT
path Parameters
zip
required
string
Example: 12345

Zip code of the coverage Service Area.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Add or Update Coverage Areas

Add or update a Coverage Area in the system. [Rev 1.17]

Authorizations:
SWT
path Parameters
zip
required
string
Example: 12345
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
coverageIndicatorID
required
integer

Unique identifier for the coverage indicator.

csa
required
string

Description of the coverage indicator.

regionID
integer

Unique identifier for the location ID of region.\n

Note

Region ID must be a location of Type region. A list of regions can be found by using the Search Regions operation in the Location management service

Responses

Request samples

Content type
application/json
{
  • "coverageIndicatorID": 1000,
  • "csa": "Not Available",
  • "regionID": 4
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Customer

Resources related to managing customers.

List Retail Warranty Information for Customer

Return Retail Warranty Information for a Customer. [Rev 1.09]

Available Fields

The following is a list of fields and how they can be used within the search.

  • Filterable : finalizedDate, receiptNumber, retailProductCatalogID, retailProductID, serviceID, serviceNumber, sku, warrantyID, warrantyTerm, warrantyExpirationDate
  • Sortable : finalizedDate, receiptNumber, retailProductCatalogID, retailProductID, serviceID, serviceNumber, sku, warrantyDescription, warrantyID, warrantyTerm, warrantyExpirationDate
Authorizations:
SWT
path Parameters
id
required
integer

Unique identifier for the Customer.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=Name eq 'AuthorizationProvider1'

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=Name

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. If no $orderby is specified, the default sort order is descending by UserID.

$select
string
Example: $select=AuthorizationURI

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
number
Example: $skip=10

Number of search results to skip.

$skiptoken
number
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
number
Example: $top=1

Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Search Customer Service Summary

Search for service summaries on a customer.

Available Fields

The following is a list of fields and how they can be used within the search.

  • Filterable : isPrimaryService, endDate, serviceID, catalogID, serviceNumber, startDate
  • Sortable : isPrimaryService, endDate, serviceID, catalogID, serviceNumber, startDate
Authorizations:
SWT
path Parameters
id
required
string
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all documents that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=Name eq 'AuthorizationProvider1'

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=Name

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. If no $orderby is specified, the default sort order is descending by UserID.

$select
string
Example: $select=AuthorizationURI

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Device

Resources related to managing devices.

Create a Device

Creates a Device. [Rev 1.14]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
aKey
string

An authorization key.

alternateSerialNumber
string

An alternate representation of the device's serial number.

Note

This field is required when serialNumber is not specified and is ignored when serialNumber is specified.

bind
boolean

Indicates whether or not the device is currently bound.

blackBerryRegistrationID
integer

Device's BlackBerry Registration ID.

decimalPseudoESN
string

Decimal representation of the ESN

deviceID
integer

Unique identifier for the device.

deviceStatusID
required
string

Unique identifier for the device's status

eid
string

For use with eSIMs, the eid or 'Embedded Identity Document' is a unique identifier built-in to the device. [Rev 2.00]

Note

This field is ignored for CDMA or if the device's SIM class is SIM Card Only.

handsetCatalogID
integer

Unique identifier of device's product catalog value.

Note

This field is required when technologyTypeID is not specified.

hexPseudoESN
string

Hex representation for the device.

hardwareVersion
string

Version of the software the device is on.

isNew
boolean

Indicates whether or not this device is new.

msl
string

Mast subsidy lock value for the device.

oneTimeSL
string

One time SL number for the device.

pin
string

PIN associated with the device.

referenceNumber
string

Reference number associated with the device.

reservedForRetail
boolean

If true, will mark the device as reserved for retail.

serialNumber
string

Serial number for the device.

Note

This field is required when alternateSerialNumber is not specified.

sid
string

System Identification Number for the device.

simCardNumber
string

Number for the SIM Card associated with the device.

Note

This field is ignored for CDMA.

sourceCodeID
integer

Unique identifier for the device's source code.

softwareVersion
string
technologyTypeID
integer

Unique identifier for the device's technology type.

Note

This field is required when handsetCatalogID is not specified and is ignored when handsetCatalogID is specified.

Responses

Request samples

Content type
application/json
{
  • "aKey": null,
  • "alternateSerialNumber": "XXXXXXXXXX",
  • "bind": true,
  • "blackBerryRegistrationID": 1,
  • "decimalPseudoESN": "1010",
  • "deviceID": 1000,
  • "deviceStatusID": 1,
  • "eid": "11223344556677889900",
  • "handsetCatalogID": 10058,
  • "hexPseudoESN": "2F",
  • "hardwareVersion": "2x",
  • "isNew": false,
  • "msl": "12",
  • "oneTimeSL": "128",
  • "pin": "8888",
  • "referenceNumber": "78-987",
  • "reservedForRetail": true,
  • "serialNumber": "XXXXXXXXXX",
  • "sid": "000000",
  • "simCardNumber": "12345678901234567890",
  • "sourceCodeID": 16,
  • "softwareVersion": "Version of the software the device is on.",
  • "technologyTypeID": 2
}

Response samples

Content type
application/json
{
  • "aKey": null,
  • "alternateSerialNumber": "XXXXXXXXXX",
  • "alternateSerialNumberCheckDigit": 8,
  • "bind": true,
  • "blackBerryRegistrationID": 1,
  • "decimalPseudoESN": "1010",
  • "deviceID": 1000,
  • "deviceStatus": "Stolen",
  • "deviceStatusID": 1,
  • "displayName": "webInvoice",
  • "eid": "11223344556677889900",
  • "handsetCatalog": "LG",
  • "handsetCatalogID": 10058,
  • "hexPseudoESN": "2F",
  • "hardwareVersion": "2x",
  • "isNew": false,
  • "lastBoundStateChangeDate": "2018-03-27T23:11:25.000Z",
  • "lastModifiedDate": "2018-03-27T23:11:25.000Z",
  • "lastModifiedUserID": "2018-03-27T23:11:25.000Z",
  • "msl": "12",
  • "oneTimeSL": "128",
  • "pin": "8888",
  • "referenceNumber": "78-987",
  • "reservedForRetail": true,
  • "serialNumber": "XXXXXXXXXX",
  • "serialNumberType": "MEID",
  • "serialNumberTypeID": 2,
  • "sid": "000000",
  • "simCardNumber": "12345678901234567890",
  • "simClass": "eSIM Only",
  • "simClassID": 1,
  • "sourceCode": "Source Code 1",
  • "sourceCodeID": 16,
  • "softwareVersion": "Version of the software the device is on.",
  • "supportedSIMClass": "eSIM or SIM Card",
  • "supportedSIMClassID": 2,
  • "technologyType": "Name of the device's technology type",
  • "technologyTypeID": 2
}

Search Devices

Search for devices in the system. [Rev 1.13]

Available Fields

The following is a list of fields for a device and how they can be used within a search.

  • Filterable : alternateSerialNumber, deviceID, deviceStatusID, displayName, eid, handsetCatalogID, serialNumber, serialNumberTypeID, simClassID, sourceCodeID, supportedSIMClassID, technologyTypeID
  • Sortable : alternateSerialNumber, deviceStatus, displayName, eid, lastBoundStateChangeDate, lastModifiedDate, serialNumber, simClass, sourceCode, supportedSIMClass
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Update a Device

Updates a specific device by ID. [Rev 1.14]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Device, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create a Device.

Patchable Fields

Allowed patch operations for each patchable property of a device.

  • aKey : add, remove, replace

  • alternateSerialNumber : add, remove, replace

  • bind : replace

  • blackBerryRegistrationID : add, remove, replace [Rev 2.06]

  • decimalPseudoESN : add, remove, replace [Rev 2.06]

  • deviceStatusID : replace

  • eid : add, remove, replace [Rev 2.00]

  • handsetCatalogID : add, remove, replace

  • hardwareVersion : add, remove, replace

  • hexPseudoESN : add, remove, replace [Rev 2.06]

  • isNew : add, remove, replace [Rev 2.06]

  • msl : add, remove, replace

  • oneTimeSL : add, remove, replace [Rev 2.06]

  • pin : add, remove, replace [Rev 2.06]

  • referenceNumber : add, remove, replace [Rev 2.06]

  • reservedForRetail : replace

  • serialNumber : add, remove, replace

  • sid : add, remove, replace [Rev 2.06]

  • simCardNumber : add, remove, replace

  • softwareVersion : add, remove, replace

  • sourceCodeID : add, remove, replace

  • technologyTypeID : add, remove, replace

Authorizations:
SWT
path Parameters
deviceID
required
integer

Unique ID of the Device.

query Parameters
updateAssociatedServices
boolean
Example: updateAssociatedServices=false

Indicates whether or not all services associated with the device should be updated with matching SIM information, regardless of whether SIMCardNumber is changed on the device. [Rev 2.06]

Default Value

false

Note

Services associated with the device will not be updated unless SIM information exists on the device after the update.

validateReservedForRetail
boolean
Example: validateReservedForRetail=false

Indicates whether or not ReservedForRetail should be disallowed when a device is currently 'bound' or associated with an active service. [Rev 2.06]

Default Value

false

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get a Device

Retrieve a specific device by ID. [Rev 1.14]

Authorizations:
SWT
path Parameters
deviceID
required
integer

Unique ID of the Device to retrieve.

Responses

Response samples

Content type
application/json
{
  • "aKey": null,
  • "alternateSerialNumber": "XXXXXXXXXX",
  • "alternateSerialNumberCheckDigit": 8,
  • "bind": true,
  • "blackBerryRegistrationID": 1,
  • "decimalPseudoESN": "1010",
  • "deviceID": 1000,
  • "deviceStatus": "Stolen",
  • "deviceStatusID": 1,
  • "displayName": "webInvoice",
  • "eid": "11223344556677889900",
  • "handsetCatalog": "LG",
  • "handsetCatalogID": 10058,
  • "hexPseudoESN": "2F",
  • "hardwareVersion": "2x",
  • "isNew": false,
  • "lastBoundStateChangeDate": "2018-03-27T23:11:25.000Z",
  • "lastModifiedDate": "2018-03-27T23:11:25.000Z",
  • "lastModifiedUserID": "2018-03-27T23:11:25.000Z",
  • "msl": "12",
  • "oneTimeSL": "128",
  • "pin": "8888",
  • "referenceNumber": "78-987",
  • "reservedForRetail": true,
  • "serialNumber": "XXXXXXXXXX",
  • "serialNumberType": "MEID",
  • "serialNumberTypeID": 2,
  • "sid": "000000",
  • "simCardNumber": "12345678901234567890",
  • "simClass": "eSIM Only",
  • "simClassID": 1,
  • "sourceCode": "Source Code 1",
  • "sourceCodeID": 16,
  • "softwareVersion": "Version of the software the device is on.",
  • "supportedSIMClass": "eSIM or SIM Card",
  • "supportedSIMClassID": 2,
  • "technologyType": "Name of the device's technology type",
  • "technologyTypeID": 2
}

Disassociate

Provides the ability to disassociate a device from all the current services currently associated with it. The act of disassociation will unbind the phone from device and set the service's device to a temporary device with a temporary serial number. [Rev 1.13]

Authorizations:
SWT
path Parameters
deviceID
required
number
Example: 1

Unique identifier for the device to disassociate

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
allowOnActiveServices
boolean

Indicates whether or not the update should be allowed on active services.

deviceStatusID
integer

New status for the device once it is disassociated from all services.

sourceCodeID
integer

New source code for the device once it is disassociated from all services.

reserveForRetail
boolean

If true, will mark the device as reserved for retail once it is disassociated from any services.

Responses

Request samples

Content type
application/json
{
  • "allowOnActiveServices": true,
  • "deviceStatusID": 4,
  • "sourceCodeID": 16,
  • "reserveForRetail": false
}

Response samples

Content type
application/json
{
  • "servicesDisassociated": 0
}

E911

Resources related to managing E911 features.

Add E911 Batch Detail

Creates an E911 batch Detail record. [Rev 2.17]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
CustomerID
required
integer

Unique identifier of the customer.

E911ClassOfServiceID
required
integer

Unique identifier of the E911 Class Of Service for the service.

E911TypeOfServiceID
required
integer

Unique identifier of the E911 Type Of Service for the service.

FunctionCode
required
string

The Function Code value indicating the CRUD step for the Batch Detail

ServiceAddressID
required
integer

Unique identifier of the Service Address record.

ServiceNumber
required
string

A string specifying the service number of the service.

E911ProviderID
integer

Unique identifier of the E911 provider. [Rev 2.35]

Responses

Request samples

Content type
application/json
{
  • "CustomerID": 1,
  • "E911ClassOfServiceID": 1,
  • "E911TypeOfServiceID": 1,
  • "FunctionCode": "C",
  • "ServiceAddressID": 1,
  • "ServiceNumber": "1",
  • "E911ProviderID": null
}

Response samples

Content type
application/json
{
  • "communityName": "community",
  • "companyID": "company",
  • "countyID": "county",
  • "createDate": "2021-02-15",
  • "customerCode": "customer",
  • "customerID": 1,
  • "customerName": "name",
  • "e911BatchDetailID": 1,
  • "e911BatchDetailStatusID": 1,
  • "e911BatchID": 1,
  • "e911ClassOfServiceID": 1,
  • "e911FunctionCode": "C",
  • "e911TypeOfServiceID": 1,
  • "esn": "value",
  • "exchange": "exchange",
  • "houseNumber": "100",
  • "houseNumberSuffix": "STE 3",
  • "location": "location",
  • "postDirectional": "S",
  • "prefixDirectional": "S",
  • "serviceID": 1,
  • "serviceNumber": "1234",
  • "sourceID": "1",
  • "state": "NY",
  • "streetName": "name",
  • "streetSuffix": "Av",
  • "tarCode": "1",
  • "userID": "name",
  • "zipCode": "12345",
  • "zipPlus4": "1111"
}

Feature

Resources related to managing features.

Update a Feature

Provides the ability to update installment plan information for a feature. This operation uses the JSON Patch document structure for defining updates to the Message objects. Read more about JSON Patch (RFC 6902) Here.

Note

Installment Plans

  • Features that are retail installment plan fatures cannot modify payInInstallments or numberOfInstallments.
  • The derived charge of the feature must be greater or equal to than 0.
  • If the feature's billed charge is greater than 0, the monthly installment charge must be greater than 0.
  • The product catalog definition for the featue must be configured to alow the feature to be paid in installments.
  • If the feature has been billed, payInInstallments and numberOfInstallments cannot be modified
  • The quantity of the feature must be 1 to allow the feature to be paid in installments.

Patchable Fields

The following is a list of properties that can be patched.

  • payInInstallments : replace
    • If this is set to false, all installment plan details for the feature will be deleted and numberOfInstallments will be 0.
  • numberOfInstallments : add, replace
    • This property requires payInInstallments to be true.
    • If this property is specified, but payInInstallments is false, this property will be ignored.
Authorizations:
SWT
path Parameters
id
required
number
Example: 1

Unique identifier of the feature.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Package

Resources related to managing packages.

List Tax By Component Allocations

Provides the ability to get the tax by component allocation values for the children of a one price package.

Note

  • Package must be a one price package
  • Package must be marked as tax by component
path Parameters
id
required
integer
Example: 1

Unique identifier of the package feature.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Set Tax By Component Allocation

Provides the ability to set the tax by component allocation values for the children of a one price package.

Note

  • Package must be a one price package
  • Package must be marked as tax by component
path Parameters
id
required
integer
Example: 1

Unique identifier of the package feature.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
chargeOverride
number

This value is summed with the other allocation charges to determine the percentage of tax that is applicable to this feature. Setting this value to null will remove the override charge.

endDate
string <date>

Date that the allocation no longer applies to this feature.

featureID
integer

Child feature to apply the charge allocation to.

startDate
string <date>

Date that the allocation should start to apply to this feature.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Service

Resources related to managing services.

Search Services For Advance Pay

Search for advance pay services in the system. [Rev 2.20]

Available Fields

The following is a list of fields and how they can be used within the search.

  • Filterable: advancePayPricePointDefinition, advancePayPricePointDefinitionID, autoRenewAdvancePay, customerID [Rev 2.20], planDescription, planID, serviceID, serviceName, serviceNumber, servicetype
  • Sortable: advancePayPricePointDefinition, advancePayPricePointDefinitionID, autoRenewAdvancePay, charge [Rev 2.37], duration [Rev 2.37], customerID [Rev 2.20], planDescription, planID, serviceID, serviceName, serviceNumber, servicetype
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get Service Phone Book

Get the phone book information associated with a service. [Rev 1.05]

Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier for the service.

Responses

Response samples

Content type
application/json
{
  • "phoneBookAccountID": 2931,
  • "phoneBookID": 115
}

List Favorite Advance Pay Price Points

Get the favorite Advance Pay price points associated with a service. [Rev 1.12]

Available Fields

The following indicates how each field can be used.

  • Filterable : advancePayPricePointDefinitionID, catalogID, featureID
  • Sortable : advancePayPricePointDefinition, description, sku, startDate
Authorizations:
SWT
path Parameters
serviceId
required
integer
Example: 1

Unique identifier for the service.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

List Service Extended Tax Exemptions

Get the extended tax exemptions information associated with a service. [Rev 1.08]

Available Fields

The following is a list of field and how they can be used within a search.

  • Filterable: taxExemptionCategoryID, taxTypeID, taxTypeExemptGroupID, taxTypeExemptID
  • Sortable: applyTaxesExceptTaxTypeExemptGroup, taxExemptionCategory, taxExemptionCategoryID, taxType, taxTypeExempt, taxTypeExemptGroup, taxTypeExemptID, taxTypeID,
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier for the service.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Update Service Extended Tax Exemptions

Add, update, and remove specified extended tax exemptions for an associated service. [Rev 1.08]

Note

  • Multiple entries for the same taxTypeExemptID in the same request will result in an error.
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier for the service.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
applyTaxesExceptTaxTypeExemptGroup
boolean

If set to false then the specified extended tax exemption does not apply to the service. If set to true then the specified extended tax exemption does apply to the service, but all other extended exemptions in the same group as the specified exemption will not apply.

remove
boolean

If set to true then the specified extended tax exemption is removed from the service. If set to false then the specified extended tax exemption is added or updated for the specified service. An update will occur for any extended tax exemptions already present on the service. An add will occur for those not present on the service.

taxTypeExemptID
integer

The unique identifier for the extended tax exemption associated to the service.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List Starting Code Summary

Get a list of starting codes used by a service. [Rev 1.18]

Available Fields

The following is a list of fields and how they can be used.

  • Filterable: billingOrderID, entryDate, receiptNumber, startingCode, startingCodeID, transactionStatusID
  • Sortable: billingOrderID, duplicateCount, entryDate, startingCode
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search Equipment Associations

Get the equipment associations for a service. [Rev 2.05]

Available Fields

The following indicates how each field can be used.

  • Filterable : equipmentID, equipmentTypeID, serviceID
  • Sortable : equipmentName, equipmentType, serviceNumber
Authorizations:
SWT
path Parameters
serviceId
required
integer
Example: 1

Unique identifier for the service.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Search Plan History

Get a history of all plans associated with a service. [Rev 1.19]

Note

A plan is a feature that belongs to the 'Plans' Exclusive Group.

Available Fields

The following is a list of fields and how they can be used.

  • Filterable: billingCycleTypeID, featureID, sku
  • Sortable: billingCycleType, charge, description, endDate, sku, startDate
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "billingCycleType": "Billing Cycle Type Description",
  • "billingCycleTypeID": 1,
  • "charge": 19.99,
  • "customerID": 12,
  • "description": "ABC123",
  • "endDate": "2020-12-31T00:00:00.000Z",
  • "featureID": 777,
  • "sku": "string",
  • "startDate": "2020-01-31T00:00:00.000Z"
}

Reverse Service Contract Penalties

Creates adjustments, of a specified type, to reverse contract penalties associated to a service between the provided disconnect and reconnect dates. [Rev 2.06]

path Parameters
id
required
integer
Example: 1

Unique identifier for the service.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
adjustmentTypeID
required
integer

Unique identifier of the adjustment type used to reverse contract penalties.

disconnectDate
required
string

The date in which the contracts were disconnected. This date must be less than the reconnect date.

reconnectDate
required
string

The date in which the contracts were reconnected.

Responses

Request samples

Content type
application/json
{
  • "adjustmentTypeID": 1,
  • "disconnectDate": "2021-01-01",
  • "reconnectDate": "2021-02-15"
}

Response samples

Content type
application/json
{
  • "amount": -10.5,
  • "skipReason": null
}

Reverse Service Installment Plans

Creates adjustments, of a specified type, to reverse installment plan charges associated to a service between the provided disconnect and reconnect dates. [Rev 2.06]

path Parameters
id
required
integer
Example: 1

Unique identifier for the service.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
adjustmentTypeID
required
integer

Unique identifier of the adjustment type used to reverse installment plan charges.

disconnectDate
required
string

The date in which the installment plans were disconnected. This date must be less than the reconnect date.

reconnectDate
required
string

The date in which the installment plans were reconnected.

Responses

Request samples

Content type
application/json
{
  • "adjustmentTypeID": 1,
  • "disconnectDate": "2021-01-01",
  • "reconnectDate": "2021-02-15"
}

Response samples

Content type
application/json
{
  • "amount": -10.5,
  • "skipReason": null
}

Search Service Phone Book Entries

Get the phonebook information associated with a service. [Rev 1.05]

Available Fields

The following is a list of field and how they can be used within a search.

  • Filterable: extension, ice, name, phone, phoneBookAccountID, phoneBookEntryID, phoneBookSpecialNumberID, rank, ringtoneID
  • Sortable: extension, ice, name, phone, phoneBookAccountID, phoneBookEntryID, phoneBookSpecialNumberID, rank, ringtoneID
Authorizations:
SWT
path Parameters
id
required
integer
Example: 1

Unique identifier for the service.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Search Services

Search for services in the system.

Available Fields

The following is a list of fields and how they can be used within the search.

  • Filterable : accountNumber [Rev 2.11], customerID [Rev 2.11], customerName [Rev 2.14], disconnectDate, eid [Rev 2.00], handsetSerialNumber, handsetAlternateSerialNumber, min, phoneBookAccountID, serviceID, serviceName, serviceNumber, serviceCatalogID, simCardSerialNumber, startDate
  • Sortable : accountNumber, customerName, customerID , disconnectDate, eid [Rev 2.00], handsetSerialNumber, handsetAlternateSerialNumber, imsi, min, serviceID, serviceName, serviceNumber, serviceCatalog, serviceCatalogID,simCardSerialNumber, startDate
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters
Content-Type
required
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Validate MSAG

Provides the ability to run MSAG validation on Service Addresses. [Rev 2.13]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
MSAGCommunity
required
string

Community for MSAG.

MSAGCounty
required
string

County for MSAG.

MSAGProviderID
integer

ID of the MSAG provider.

State
required
string

State for MSAG.

StreetName
required
string

Street Name for MSAG.

StreetNumber
required
integer

Street Number for MSAG.

StreetPostDirectional
string

Direction of the street, after the street name.

StreetPrefixDirectional
string

Direction of the street, before the street name.

StreetType
string

Type of street.

Responses

Request samples

Content type
application/json
{
  • "MSAGCommunity": "Valid Community",
  • "MSAGCounty": "County",
  • "MSAGProviderID": 3,
  • "State": "New York",
  • "StreetName": "Main",
  • "StreetNumber": 1,
  • "StreetPostDirectional": "South",
  • "StreetPrefixDirectional": "North",
  • "StreetType": "Road"
}

Response samples

Content type
application/json
{
  • "MSAGCommunity": "Valid Community",
  • "MSAGCounty": "County",
  • "MSAGError": [
    ],
  • "MSAGProviderID": 3,
  • "MSAGValidated": "01/14/2020"
}

Service E911 Information

Updates E911 information for a service. [Rev 2.16]

Note

  • This operation uses the JSON Patch document structure for defining updates to the Message objects. Read more about JSON Patch (RFC 6902) Here.

Patchable Fields

Allowed patch operations for each patchable property of a service.

  • e911ClassOfServiceID : add, remove, replace

  • e911ServiceAddressID : add, replace [Rev 2.18]

  • e911TypeOfServiceID : add, remove, replace

Authorizations:
SWT
path Parameters
serviceID
required
integer

Unique identifier for the Service to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
integer

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update a Service

Updates a service. [Rev 2.19]

Note

  • This operation uses the JSON Patch document structure for defining updates to the Message objects. Read more about JSON Patch (RFC 6902) Here.

Patchable Fields

Allowed patch operations for each patchable property of a service.

  • autoRenewAdvancePay : add, replace
Authorizations:
SWT
path Parameters
serviceID
required
integer

Unique identifier for the Service to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string

Indicates what type of JSON Patch operation being requested. Valid values are add, replace, and remove.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

SIM

Resources related to managing SIMs.

Create a SIM

Creates a SIM. [Rev 2.02]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
activationURL
string

The URL used to activate the SIM.

admPIN
string

The administrative key.

authenticationKey
string

The Authentication Key or Ki is used for authentication of the SIM on the Mobile Network.

caveAuthKey
string

The CAVE authentication key.

hexEUIMID
string

Hexadecimal expanded user identity module identifier.

hexPseudoUIMID
string

Hexadecimal pseudo user identity module identifier.

hrpdSecret
string

High rate packet data secret.

imsi
required
string

International mobile subscriber ID.

kappli
string

Another secret reference value for the SIM.

kKey
string

The KKey value.

mipAAASecret
string

The mobile IP AAA secret.

mipHASecret
string

The mobile IP home agent secret.

pin1
string

Primary personal ID number.

pin2
string

Secondary personal ID number.

profileName
string

The SIM profile name.

puk1
string

Primary pin unblocking key.

puk2
string

Secondary pin unblocking key.

simClassID
required
integer

Unique identifier of the SIM Class.

Valid Values

  • 1 - eSim
  • 2 - eSIM or SIM Card
  • 3 - SIM Card
simNumber
required
string

The serial number of the SIM.

sipSecret
string

The SIP secret.

Responses

Request samples

Content type
application/json
{
  • "activationURL": "https://www.activatemysimnowpleasethanks.com/",
  • "admPIN": "abcdxyz",
  • "authenticationKey": "abcdxyz",
  • "caveAuthKey": "abcdxyz",
  • "hexEUIMID": "abcdxyz",
  • "hexPseudoUIMID": "abcdxyz",
  • "hrpdSecret": "abcdxyz",
  • "imsi": "My IMSI",
  • "kappli": "abcdxyz",
  • "kKey": "abcdxyz",
  • "mipAAASecret": "abcdxyz",
  • "mipHASecret": "abcdxyz",
  • "pin1": "5656",
  • "pin2": "3456",
  • "profileName": "abcdxyz",
  • "puk1": "2645",
  • "puk2": "3475",
  • "simClassID": 3,
  • "simNumber": "5373573",
  • "sipSecret": "abcdxyz"
}

Response samples

Content type
application/json
{
  • "activationURL": "https://www.activatemysimnowpleasethanks.com/",
  • "admPIN": "abcdxyz",
  • "authenticationKey": "abcdxyz",
  • "caveAuthKey": "abcdxyz",
  • "hexEUIMID": "abcdxyz",
  • "hexPseudoUIMID": "abcdxyz",
  • "hrpdSecret": "abcdxyz",
  • "imsi": "My IMSI",
  • "kappli": "abcdxyz",
  • "kKey": "abcdxyz",
  • "mipAAASecret": "abcdxyz",
  • "mipHASecret": "abcdxyz",
  • "pin1": "5656",
  • "pin2": "3456",
  • "profileName": "abcdxyz",
  • "puk1": "2645",
  • "puk2": "3475",
  • "simClass": "SIM Card Only",
  • "simClassID": 3,
  • "simID": 24626,
  • "simNumber": "5373573",
  • "sipSecret": "abcdxyz"
}

Search SIM

Get the SIMs in the system. [Rev 2.00]

Available Fields

The following is a list of field and how they can be used within a search.

  • Filterable: imsi, pin1, pin2, puk1, puk2, simClass, simClassID, simID, simNumber
  • Sortable: simClass, simClassID, simNumber
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$inlinecount
string
Enum: "allpages" "none"
Example: $inlinecount=allpages

Tells the server to include the total count of matching entities in the response.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@odata.count": 145,
  • "@odata.nextLink": "https://api.idibilling.com/OrderManagement/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Get a SIM

Retrieve a specific SIM by ID. [Rev 2.02]

Authorizations:
SWT
path Parameters
simID
required
integer

Unique ID of the SIM to retrieve.

Responses

Response samples

Content type
application/json
{
  • "activationURL": "https://www.activatemysimnowpleasethanks.com/",
  • "admPIN": "abcdxyz",
  • "authenticationKey": "abcdxyz",
  • "caveAuthKey": "abcdxyz",
  • "hexEUIMID": "abcdxyz",
  • "hexPseudoUIMID": "abcdxyz",
  • "hrpdSecret": "abcdxyz",
  • "imsi": "My IMSI",
  • "kappli": "abcdxyz",
  • "kKey": "abcdxyz",
  • "mipAAASecret": "abcdxyz",
  • "mipHASecret": "abcdxyz",
  • "pin1": "5656",
  • "pin2": "3456",
  • "profileName": "abcdxyz",
  • "puk1": "2645",
  • "puk2": "3475",
  • "simClass": "SIM Card Only",
  • "simClassID": 3,
  • "simID": 24626,
  • "simNumber": "5373573",
  • "sipSecret": "abcdxyz"
}

Get an Available eSIM

Get a random eSIM that is not currently assigned to any active service. [Rev 2.27]

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "activationURL": "https://www.activatemysimnowpleasethanks.com/",
  • "admPIN": "abcdxyz",
  • "authenticationKey": "abcdxyz",
  • "caveAuthKey": "abcdxyz",
  • "hexEUIMID": "abcdxyz",
  • "hexPseudoUIMID": "abcdxyz",
  • "hrpdSecret": "abcdxyz",
  • "imsi": "My IMSI",
  • "kappli": "abcdxyz",
  • "kKey": "abcdxyz",
  • "mipAAASecret": "abcdxyz",
  • "mipHASecret": "abcdxyz",
  • "pin1": "5656",
  • "pin2": "3456",
  • "profileName": "abcdxyz",
  • "puk1": "2645",
  • "puk2": "3475",
  • "simClass": "SIM Card Only",
  • "simClassID": 3,
  • "simID": 24626,
  • "simNumber": "5373573",
  • "sipSecret": "abcdxyz"
}

Release Notes

Release Notes 2.37

Release Notes 2.36

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.35

Release Notes 2.34

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.33

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.32

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.31

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.30

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.29

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.28

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.27

Release Notes 2.26

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.25

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.24

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.23

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.22

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.21

Release Notes 2.20

Release Notes 2.19

Release Notes 2.18

  • Updated ServiceE911Information PATCH api/service/{serviceID}/serviceE911Information to make e911ServiceAddressID non-removeable.

Release Notes 2.17

Release Notes 2.16

Release Notes 2.15

  • Updated MSAGError to be an array of strings on the Response for Validate MSAG POST api/service/validateMSAG.

Release Notes 2.14

  • Updated customerName to be a filterable property of Search Services GET api/service/search.

Release Notes 2.13

Release Notes 2.12

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.11

  • Updated customerID and accountNumber to be filterable properties on Search Services GET api/service/search.

Release Notes 2.09

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.07

Release Notes 2.06

  • Added Reverse Service Contract Penalties POST api/service/{serviceID}/reverseContractPenalties
  • Added Reverse Service Installment Plans POST api/service/{serviceID}/reverseInstallmentPlans
  • Added the following to Update a Device PATCH api/device/{deviceID}
    • Query Parameter updateAssociatedServices
    • Query Parameter validateReservedForRetail
    • Patchable Field blackBerryRegistrationID
    • Patchable Field decimalPseudoESN
    • Patchable Field hexPseudoESN
    • Patchable Field isNew
    • Patchable Field oneTimeSL
    • Patchable Field pin
    • Patchable Field referenceNumber
    • Patchable Field sid

Release Notes 2.05

Release Notes 2.04

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.03

  • Added admPIN, authenticationKey, caveAuthKey, hexEUIMID, hexPseudoUIMID, hrpdSecret, kappli, kKey, mipAAASecret, mipHASecret, profileName, sipSecret to Response of Create a SIM POST api/sim and Get a SIM GET api/sim/{simID}

Release Notes 2.02

Release Notes 2.01

  • Added alternateSerialNumberCheckDigit, displayName to Get a Device GET api/device/{deviceID}
  • Added alternateSerialNumberCheckDigit, displayName to Search Devices GET api/device
  • Added alternateSerialNumberCheckDigit, displayName to response for Create a Device POST api/device

Release Notes 2.00

Release Notes 1.25

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.24

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.23

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.22

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.21

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.20

Release Notes 1.19

Release Notes 1.18

Release Notes 1.17

Release Notes 1.14

Release Notes 1.13

Release Notes 1.11

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.10

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.09

Release Notes 1.08

Release Notes 1.07

Release Notes 1.06

Release Notes 1.04

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.03

  • Added GET api/service/search
  • Added GET api/customer/{id}/serviceDetail
  • Added GET api/customer/{id}/serviceSummary

Release Notes 1.02

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.00

  • Added GET api/healthcheck