Port Request Management (2.07)

Download OpenAPI specification:Download

This PortRequestManagement API provides developers a way to query and update items related to port request activities.

System Integrity

Resources related to system integrity.

Health Check

Use to check whether or not the PortRequestManagement service is up and running.

Responses

Port Request

Resources related to creating, reading, updating and deleting port requests and their associated activities.

Search Port Request

Provides a list of port requests in the system.

Available Fields

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

  • Filterable : assignedUserID, authorizedBy, billAccountNumber, billFirstName, billingOrderID, billLastName, createDate, dueDate, initiationDate, lastActivityDate, lastActivityTypeID, portID, portMessageID, portRequestID, portServiceNumber, portStatusID, portType, serviceID, serviceInformationItemID, serviceNumberOwnerID
  • Sortable : assignedUserID, authorizedBy, billAccountNumber, billFirstName, billingOrderID, billLastName, createDate, dueDate, initiationDate, lastActivityDate, lastActivityTypeID, portID, portMessageID, portRequestID, portServiceNumber, portStatusID, portType, serviceID, serviceInformationItemID, serviceNumberOwnerID
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
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. 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
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}

Retrieve Port Request

Provides the ability to retreive details about a specific port request.

Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to retrieve.

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

Responses

Response samples

Content type
application/json
{
  • "assignedUserID": "jdoe",
  • "authorizedBy": "jdoe",
  • "billAccountNumber": "123456",
  • "billAccountPasswordPIN": "1234",
  • "billCompanyName": "My Company",
  • "billFirstName": "John",
  • "billingOrderID": 1,
  • "billLastName": "Doe",
  • "billMiddleInitial": "Q",
  • "billPrefix": "Mr",
  • "billSuffix": "Sr",
  • "city": "Victor",
  • "country": "USA",
  • "createDate": "2008-10-27T16:03:36.443-04:00",
  • "dueDate": "2008-10-27T16:03:36.443-04:00",
  • "initiationDate": "2008-10-27T16:03:36.443-04:00",
  • "lastActivityDate": "2008-10-27T16:03:36.443-04:00",
  • "lastActivityReasonCode": "1B",
  • "lastActivityReasonCodeID": 1,
  • "lastActivityRemarks": "Port In Remarks",
  • "lastActivityType": "Port In Created",
  • "lastActivityTypeID": 1,
  • "portID": "789-898",
  • "portMessageID": "10-10-2000",
  • "portRequestID": 1,
  • "portServiceNumber": "5555555555",
  • "portStatus": "Open",
  • "portStatusID": 1,
  • "portTimeZone": "ALA",
  • "portTimeZoneID": 1,
  • "portType": "PortIn",
  • "serviceID": 8795,
  • "serviceInformationItemID": 1,
  • "serviceNumberOwner": "Carrier X",
  • "serviceNumberOwnerID": 8,
  • "ssn": "123456789",
  • "state": "NY",
  • "streetDirection": "N",
  • "streetName": "Phillips Road",
  • "streetNumber": 1,
  • "taxID": "123456789",
  • "zipCode": "14456"
}

Update Port Request

Provides the ability to update details about a specific port request.

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

Note

  • This operation can only be performed on Open or Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.

Patchable Fields

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

  • billAccountNumber: add, replace
  • billAccountPasswordPIN: add, remove, replace
  • billCompanyName: add, remove, replace
  • billFirstName: add, remove, replace
  • billLastName: add, remove, replace
  • billMiddleInitial: add, remove, replace
  • billPrefix: add, remove, replace
  • billSuffix: add, remove, replace
  • city: add, remove, replace
  • country: add, remove, replace
  • lastActivityRemarks: add

    Note: Use this field to enter any remarks for the created port activity.

  • portTimeZoneID: add, remove*, replace

    Note: This field cannot be removed if the associated service requires time zone for ports.

  • serviceNumberOwnerID: add, replace
  • ssn: add, remove, replace
  • state: add, remove, replace
  • streetDirection: add, remove, replace
  • streetName: add, remove, replace
  • streetNumber: add, remove, replace
  • taxID: add, remove, replace
  • zipCode: add, replace
Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to retrieve.

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
required
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
{
  • "assignedUserID": "jdoe",
  • "authorizedBy": "jdoe",
  • "billAccountNumber": "123456",
  • "billAccountPasswordPIN": "1234",
  • "billCompanyName": "My Company",
  • "billFirstName": "John",
  • "billingOrderID": 1,
  • "billLastName": "Doe",
  • "billMiddleInitial": "Q",
  • "billPrefix": "Mr",
  • "billSuffix": "Sr",
  • "city": "Victor",
  • "country": "USA",
  • "createDate": "2008-10-27T16:03:36.443-04:00",
  • "dueDate": "2008-10-27T16:03:36.443-04:00",
  • "initiationDate": "2008-10-27T16:03:36.443-04:00",
  • "lastActivityDate": "2008-10-27T16:03:36.443-04:00",
  • "lastActivityReasonCode": "1B",
  • "lastActivityReasonCodeID": 1,
  • "lastActivityRemarks": "Port In Remarks",
  • "lastActivityType": "Port In Created",
  • "lastActivityTypeID": 1,
  • "portID": "789-898",
  • "portMessageID": "10-10-2000",
  • "portRequestID": 1,
  • "portServiceNumber": "5555555555",
  • "portStatus": "Open",
  • "portStatusID": 1,
  • "portTimeZone": "ALA",
  • "portTimeZoneID": 1,
  • "portType": "PortIn",
  • "serviceID": 8795,
  • "serviceInformationItemID": 1,
  • "serviceNumberOwner": "Carrier X",
  • "serviceNumberOwnerID": 8,
  • "ssn": "123456789",
  • "state": "NY",
  • "streetDirection": "N",
  • "streetName": "Phillips Road",
  • "streetNumber": 1,
  • "taxID": "123456789",
  • "zipCode": "14456"
}

Assign Port Request

Updates the assignedUserID of the port to the assignee

Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to change the assignment of.

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

The user to assign the port to. If empty the port will be unassigned.

Responses

Request samples

Content type
application/json
{
  • "assignee": "jdoe"
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Cancel Port Request

Submits a cancel request for a port.

Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to cancel.

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

Remarks associated with the request.

Responses

Request samples

Content type
application/json
{
  • "remarks": "Port request is under review."
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Confirm Port Request

Submits a confirmation for a port out or port in.

Note

  • Port Out: This operation can only be performed on Open or Pending ports of type PortOut that do not have a last activity type of Confirmation Submitted, Delay Notice Submitted, Port In Cancel Submitted, or Resolution Required Submitted.
  • Port In: This operation can only be performed on Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted [Rev 1.07].
Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to confirm.

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

Information about confirmation response received from porting provider.

Note

  • Required for confirming ports of port type PortIn.
remarks
string

Remarks associated with the request.

responseNumber
string

Response number issued by the porting provider. [Rev. 1.10]

Note

  • Only applicable for confirming ports of port type PortIn.

Responses

Request samples

Content type
application/json
{
  • "description": "Description of the request",
  • "remarks": "Manually confirming port request per supervisor instruction."
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Delay Port Out Request

Submits a delay notification for a port out.

Note

  • This operation can only be performed on Open or Pending ports of type PortOut that do not have a last activity type of Confirmation Submitted, Delay Notice Submitted, Port In Cancel Submitted, or Resolution Required Submitted.
Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to delay.

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

Date port out is delayed until.

Note

This date must be in the future.

remarks
string

Remarks associated with the request.

Responses

Request samples

Content type
application/json
{
  • "delayDate": "2008-10-27T16:03:36.443-04:00",
  • "remarks": "Manually delaying port request per supervisor instruction."
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Delay Received

Updates port request with delay information received from the porting provider [Rev 1.08].

Note

  • This operation can only be performed on Open or Pending ports of type PortIn.
Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to delay.

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

Date port in is delayed until.

Note

This date must be in the future.

description
string

Information about the delay received from the porting provider.

remarks
string

Remarks associated with the request.

responseNumber
string

Response number issued by the porting provider. [Rev. 1.10]

Responses

Request samples

Content type
application/json
{
  • "delayDate": "2008-10-27T16:03:36.443-04:00",
  • "description": "Delay received",
  • "remarks": "Delay received from porting provider.",
  • "responseNumber": "01"
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Force Cancel Port Request

Forces the status of a port in or port out request to canceled and, for port ins, bypasses the submission process.

Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to force cancel.

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

Remarks associated with the request.

Request samples

Content type
application/json
{
  • "remarks": "Port request is under review."
}

Force Complete Port Request

Forces the status of a port in or port out request to completed and, for port ins, bypasses the submission process.

Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to force complete.

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

Remarks associated with the request.

Responses

Request samples

Content type
application/json
{
  • "remarks": "Port request is under review."
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Initiate Port Request

Updates a port in request to have the specified initiation date.

Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to retrieve.

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

Date the port should be initiated on.

  • Default Value : current date
remarks
string

Remarks associated with the request.

Responses

Request samples

Content type
application/json
{
  • "initiationDate": "2008-10-27T16:03:36.443-04:00",
  • "remarks": "Initiating port request."
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Create Port Request Message

Create a message associated to a port request [Rev 1.07].

Authorizations:
SWT
path Parameters
portRequestID
required
integer
Example: 1

Unique identifier for the port request to retrieve.

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

Date the message was received.

  • Default Value : current date
messageBody
required
string

Contents of the message.

messageType
required
string

Type of port request message.

Responses

Request samples

Content type
application/json
{
  • "createDate": "2018-10-27T16:03:36.443-04:00",
  • "messageBody": "Sample Message",
  • "messageType": "ACK"
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Require Resolution

For a port out, submits a resolution required notification. For a port in, this should be called when a require resolution request is received from the porting provider.

Note

This operation can only be performed on Open or Pending ports of type PortOut that do not have a last activity type of Port In Cancel Submitted, Confirmation Submitted, Delay Notice Submitted or Resolution Required Submitted.

Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to submit a require resolution request for.

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

Unique identifier for a port request reason code to associate with this request.

remarks
string

Remarks associated with the request.

Responses

Request samples

Content type
application/json
{
  • "reasonCodeID": 1,
  • "remarks": "A resolution is required for this port request."
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Require Resolution Received

For a port in, denotes that this port request requires additional information or clarification and that a notification has been received from the old service provider that requires resolution. [Rev 1.07]

Note

This operation can only be performed on Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.

Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to submit a require resolution received request for.

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

The port reason code describing why this port in request requires resolution.

reasonDetail
required
string

A detailed description of why this port in request requires resolution.

remarks
string

Remakrs associated with the request.

responseNumber
string

Response number issued by the porting provider. [Rev. 1.10]

Responses

Request samples

Content type
application/json
{
  • "reasonCode": "6D",
  • "reasonDetail": "string",
  • "remarks": "A resolution is required for this port request.",
  • "responseNumber": "01"
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Set Due Date

Updates a port in request to have the specified due date.

Note

  • This operation can only be performed on Open or Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.
Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to update.

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

New due date for the port.

remarks
string

Remarks associated with the set due date request.

Responses

Request samples

Content type
application/json
{
  • "dueDate": "2008-10-27T16:03:36.443-04:00",
  • "remarks": "Port needs additional time to process."
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Port In Error

Updates a port in request with error information received from response of the porting provider [Rev. 1.07].

Note

  • This operation can only be performed on Open or Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.
Authorizations:
SWT
path Parameters
portRequestID
required
integer
Example: 1

Unique identifier for the port request to update.

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

Information about error received from porting provider.

remarks
string

Remarks associated with the request.

responseNumber
string

Response number issued by the porting provider. [Rev. 1.10]

Responses

Request samples

Content type
application/json
{
  • "description": "RESPONSE_CODE: 00",
  • "remarks": "Port In Error Received from porting provider.",
  • "responseNumber": "01"
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

Port In Response

Updates a port in request with information received from response from the porting provider [Rev 1.07].

Note

  • This operation can only be performed on Open or Pending ports of type PortIn that do not have a last activity type of Port In Cancel Submitted.
Authorizations:
SWT
path Parameters
portRequestID
required
integer
Example: 1

Unique identifier for the port request to update.

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

Information about response received from porting provider.

portID
string

External identifier for the port request issued by the porting provider. [Rev. 1.10]

remarks
string

Remarks associated with the request.

responseNumber
string

Response number issued by the porting provider. [Rev. 1.10]

Responses

Request samples

Content type
application/json
{
  • "description": "RESPONSE_CODE: 00",
  • "portID": "U1RFVkU=",
  • "remarks": "Port In Response Received from porting provider.",
  • "responseNumber": "01"
}

Response samples

Content type
application/json
{
  • "loggingNumber": 500032,
  • "message": "You do not have access to foo ID 1 or it does not exist.",
  • "field": "exampleField"
}

List Port Activities

Provides a list of port activities for a port request.

Available Fields

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

  • Filterable : createDate, description, dueDate, portActivityID, portActivityType, portActivityTypeID, portID, portReasonCode, portReasonCodeID, portRequestID, portTimeZone, portTimeZoneID, remarks, responseNumber, userID
  • Sortable : createDate, description, dueDate, portActivityID, portActivityType, portActivityTypeID, portID, portReasonCode, portReasonCodeID, portRequestID, portTimeZone, portTimeZoneID, remarks, responseNumber, userID
Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier for the port request to retrieve port activities for.

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
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. 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
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}

Retrieve Port Activity

Provides the ability to retreive details about a specific port request activity.

Authorizations:
SWT
path Parameters
portRequestID
required
number
Example: 1

Unique identifier of the port request associated with the activity to retrieve.

portActivityID
required
number
Example: 1

Unique identifier for the port activity to retrieve.

header Parameters
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "createDate": "2008-10-27T16:03:36.443-04:00",
  • "description": "",
  • "dueDate": "2008-10-27T16:03:36.443-04:00",
  • "portActivityID": 1,
  • "portActivityType": "Port In Created",
  • "portActivityTypeID": 1,
  • "portID": "",
  • "portReasonCode": "1B",
  • "portReasonCodeID": 1,
  • "portRequestID": 1,
  • "portTimeZone": "ALA",
  • "portTimeZoneID": 1,
  • "remarks": "Port In Remarks",
  • "responseNumber": "1234A",
  • "userID": "jdoe"
}

Auxiliary Data

Read only resources that provide additional information related to port requests.

Search Port Activity Types

Provides a list of available port activity types available in the system.

Available Fields

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

  • Filterable : description, isPortInActivity, isPortOutActivity, portActivityTypeID
  • Sortable : description, isPortInActivity, isPortOutActivity, portActivityTypeID
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
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. 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
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}

Search Port Reason Codes

Provides a list of port reason codes available in the system.

Available Fields

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

  • Filterable : description, portReasonCodeID, reasonCode
  • Sortable : description, portReasonCodeID, reasonCode
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
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. 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
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}

Search Port Status

Provides a list of available port statuses available in the system. [Rev 1.01]

Available Fields

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

  • Filterable : description, portStatusID
  • Sortable : description, portStatusID
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
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. 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
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}

Search Port Time Zones

Provides a list of available port time zones available in the system.

Available Fields

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

  • Filterable : description, portTimeZoneID, timeZone
  • Sortable : description, portTimeZoneID, timeZone
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
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. 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
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}

Search Service Number Owners

Provides a list of available service number owners available in the system.

Available Fields

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

  • Filterable : allowPortIns, allowPortOuts, description, marketType, marketTypeID, serviceNumberOwnerID, spid
  • Sortable : allowPortIns, allowPortOuts, description, marketType, marketTypeID, serviceNumberOwnerID, spid
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
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. 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
{
  • "@count": 145,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/portrequestmanagement/{ennvironment}/api/odataquery?$filter=field1 eq"
}

Syniverse Porting Configuration

Resources related to reading, updating, and deleting the Syniverse Porting Configuration.

Create Syniverse Porting Configuration

Create the Syniverse Porting Configuration and restart the Syniverse Porting Workers.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
required
Array of objects (LRN)

LRN Configuration

required
object (MQClientConfiguration)

MQ Client Connection Configuration

required
object (PortingCustomer)

Porting Customer Configuration

spid
required
string

Service Number Owner SPID

Responses

Request samples

Content type
application/json
{
  • "lrnConfiguration": [
    ],
  • "mqClientConfiguration": {
    },
  • "portingCustomerConfiguration": {
    },
  • "spid": "1234A"
}

Retrieve Syniverse Porting Configuration

Retrieves the Syniverse Porting Configuration.

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "lrnConfiguration": [
    ],
  • "mqClientConfiguration": {
    },
  • "portingCustomerConfiguration": {
    },
  • "spid": "1234A"
}

Delete Syniverse Porting Configuration

Delete the Syniverse Porting Configuration and restart the Syniverse Porting Workers.

Authorizations:
SWT

Responses

Release Notes

Release Notes 2.07

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

Release Notes 2.06

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

Release Notes 2.05

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

Release Notes 2.04

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

Release Notes 2.03

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

Release Notes 2.02

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

Release Notes 2.01

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

Release Notes 2.00

  • Major version change was for internal changes only and not a breaking change.

Release Notes 1.19

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

Release Notes 1.18

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

Release Notes 1.17

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

Release Notes 1.15

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

Release Notes 1.14

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

Release Notes 1.13

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

Release Notes 1.12

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

Release Notes 1.11

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

Release Notes 1.10

Release Notes 1.09

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

Release Notes 1.08

Release Notes 1.07

Release Notes 1.06

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

Release Notes 1.05

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

Release Notes 1.04

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

Release Notes 1.03

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

Release Notes 1.02

  • Internal changes only, did not affect external API

Release Notes 1.01

Release Notes 1.00

  • Added new PortRequestManagement API endpoint