logo
API docs by Redocly

Number Inventory Service (2.06)

Number Inventory Service Concepts

Abstract

The primary purpose of the Number Inventory service is to provide the ability to find and reserve available service numbers and MINs.

Operations

Create Reservation

Provides the ability to create a reservation including the details for reserving multiple inventory items.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/SecurityService1/CreateReservation
Request Body schema: application/soap+xml
required
object (CreateReservation)

Provides the ability to create a reservation including the details for reserving multiple inventory items.

Responses

Find Available Service Numbers

Provides the ability to find some quantity of service number inventory items that are currently available for use in a specified inventory and group.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/numberinventoryservice1/FindAvailableServiceNumbers
Request Body schema: application/soap+xml
required
object (FindAvailableServiceNumbers)

Provides the ability to find some quantity of service number inventory items that are currently available for use in a specified inventory and group.

Responses

Modify Reservation

Provides the ability to modify an existing reservation including new details for reserving multiple inventory items.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action="https://webservices.idibilling.com/numberinventoryservice1/ModifyReservation
Request Body schema: application/soap+xml
required
object (ModifyReservation)

Provides the ability to modify an existing reservation including new details for reserving multiple inventory items.

Responses

Core Data Service

Abstract

The purpose of the CoreDataService endpoint is to supply a set of search capabilities that can be used for data retrieval.

Authorization

In order to retrieve information from a data service, proper authorization credentials must be included in a header of the request. To do this, first find the Simple Web Token claim (ClaimType = "http://idibilling.com/SWT") within the Request Security Token returned to you from the 'Issue' call to the Security Token Service. Once found, the Simple Web Token must be submitted with each request in an "Authorization" header with a value in exactly the following format: WRAP access_token="<Simple Web Token>" where <Simple Web Token> between double quotes is replaced with the SWT claim string value between double quotes.

Inventoried Service Number

A list of all the inventoried service numbers in the system.

query Parameters
$count
number
Example: $count=3
  • 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 'Value'
  • 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.
$select
string
Example: $select=Name
  • 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
{
  • "AccountNumber": "My Account Number",
  • "AvailableDate": "2017-09-09T17:35:09.156Z",
  • "BlockID": 47,
  • "BlockNPANXX": "NPA-NXX",
  • "BlockPriorityNumber": 4,
  • "BlockServiceNumberOwner": "My BlockServiceNumberOwner",
  • "BlockServiceNumberOwnerID": 547,
  • "BlockStatus": "Avaliable",
  • "BlockType": "Code Holder",
  • "BlockX": "NPA-NXX-X",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "John Smith",
  • "CustomerID": 477,
  • "CustomerName": "Fred Rogers",
  • "Inventory": "Inventory Name",
  • "InventoryID": 547,
  • "IsPortedInNumber": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Michael Jackson",
  • "NRUFCategory": "Reserved",
  • "NRUFSubcategory": "Local Routing Numbers",
  • "PortedFromServiceNumberOwner": "ServiceNumberOwner Name",
  • "PortedFromServiceNumberOwnerID": 457,
  • "PortedToServiceNumberOwner": "ServiceNumberOwner Name",
  • "PortedToServiceNumberOwnerID": 4684,
  • "ReservationDetailID": 4578,
  • "ServiceNumber": "My Service Number",
  • "Status": "Aging",
  • "StatusChangeDate": "2017-09-09T17:35:09.156Z",
  • "InventoryItemID": 6868,
  • "StatusID": 6
}

Inventory Group

A list of all the inventory groups configured in the system.

query Parameters
$count
number
Example: $count=3
  • 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 'Value'
  • 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.
$select
string
Example: $select=Name
  • 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
{
  • "Description": "My Description",
  • "InventoryGroupID": 346,
  • "InventoryGroupType": "My InventoryGroupType"
}

Reservation

A list of all the inventory reservations in the system.

query Parameters
$count
number
Example: $count=3
  • 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 'Value'
  • 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.
$select
string
Example: $select=Name
  • 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
{
  • "AccountNumber": "My Account Number",
  • "City": "New York City",
  • "CompanyName": "My Company Name",
  • "ContactID": 4746,
  • "Country": "Canada",
  • "CustomerID": 6478,
  • "CustomerName": "My Customer Name",
  • "Email1": "primaryEmail@mail.com",
  • "Email1Type": "My Primary Email Type",
  • "FinalExpirationDate": "2017-09-09T17:35:09.156Z",
  • "FirstName": "John",
  • "LastName": "Smith",
  • "OrderID": 457,
  • "OrderState": "My OrderState",
  • "OrderStateID": 457,
  • "Phone1": "123-456-7891",
  • "Phone1Type": "My primary phone number type",
  • "ReservationID": 457,
  • "State": "North Dakota",
  • "Status": "Completed",
  • "Street1": "2354 Picasso Lane, old town, Minnesota",
  • "Street2": "445 Mount Eden Road, Mount Eden, Auckland",
  • "ZipCode": "14513"
}

Reservation Detail

A list of all the inventory reservation details in the system.

query Parameters
$count
number
Example: $count=3
  • 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 'Value'
  • 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.
$select
string
Example: $select=Name
  • 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
{
  • "AccountNumber": "My Account Number",
  • "CustomerID": 563,
  • "CustomerName": "John Smith",
  • "ExpirationDate": "2017-09-09T17:35:09.156Z",
  • "Inventory": "Inventory Name",
  • "InventoryID": 457,
  • "InventoryItem": "My InventoryItem",
  • "InventoryItemType": "ServiceNumber",
  • "OrderID": 457,
  • "OrderState": "My OrderState",
  • "OrderStateID": 547,
  • "ReservationDetailID": 564,
  • "ReservationID": 567,
  • "ReservationOrderID": 568,
  • "ReservationOrderState": "My ReservationOrderState",
  • "ReservationOrderStateID": 36,
  • "ReservedByUser": "John Smith",
  • "ReservedDate": "2017-09-09T17:35:09.156Z",
  • "ServiceInformationItemID": 767,
  • "Status": "Confirmed"
}

Inventoried MIN

A list of all the inventoried MINs in the system.

query Parameters
$count
number
Example: $count=3
  • 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 'Value'
  • 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.
$select
string
Example: $select=Name
  • 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
{
  • "AccountNumber": "My Account Number",
  • "AvailableDate": "2017-09-09T17:35:09.156Z",
  • "BlockID": 57,
  • "BlockPriorityNumber": 468,
  • "BlockStatus": "Avaliable",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "CustomerID": 4567,
  • "CustomerName": "My CustomerName",
  • "Inventory": "My Inventory Name",
  • "InventoryID": 457,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "MIN": "My MIN",
  • "ReservationDetailID": 357,
  • "Status": "Aging",
  • "StatusChangeDate": "2017-09-09T17:35:09.156Z",
  • "InventoryItemID": 546,
  • "StatusID": 9
}

Inventoried MIN By Group

A list of all the inventoried MINs in the system with any inventory groups the inventoried MIN belongs to.

query Parameters
$count
number
Example: $count=3
  • 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 'Value'
  • 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.
$select
string
Example: $select=Name
  • 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
{
  • "AccountNumber": "My Account Number",
  • "AvailableDate": "2017-09-09T17:35:09.156Z",
  • "BlockID": 685,
  • "BlockPriorityNumber": 547,
  • "BlockStatus": "Avaliable",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "CustomerID": 457,
  • "CustomerName": "My Customer Name",
  • "Inventory": "My Inventory Name",
  • "InventoryGroup": "My InventoryGroup",
  • "InventoryGroupID": 468,
  • "InventoryGroupType": "My InventoryGroupType Name",
  • "InventoryGroupTypeID": 578,
  • "InventoryID": 967,
  • "InventoryItemID": 585,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "MIN": "My MIN",
  • "ReservationDetailID": 5468,
  • "Status": "Retired",
  • "StatusChangeDate": "2017-09-09T17:35:09.156Z",
  • "StatusID": 7
}

Inventoried Service Number By Group

A list of all the inventoried service numbers in the system with any inventory groups the inventoried service number belongs to.

query Parameters
$count
number
Example: $count=3
  • 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 'Value'
  • 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.
$select
string
Example: $select=Name
  • 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
{
  • "AccountNumber": "My Account Number",
  • "AvailableDate": "2017-09-09T17:35:09.156Z",
  • "BlockID": 457,
  • "BlockNPANXX": "NPA-NXX",
  • "BlockPriorityNumber": 4,
  • "BlockServiceNumberOwner": "My ServiceNumberOwner Name",
  • "BlockServiceNumberOwnerID": 537,
  • "BlockStatus": "Not Avaliable",
  • "BlockType": "Code Holder",
  • "BlockX": "NPA-NXX-X",
  • "CreateDate": "2017-09-09T17:35:09.156Z",
  • "CreateUser": "Username",
  • "CustomerID": 467,
  • "CustomerName": "Customers Name",
  • "Inventory": "My Inventory Name",
  • "InventoryGroup": "InventoryGroup Name",
  • "InventoryGroupID": 6745,
  • "InventoryGroupType": "InventoryGroupType Name",
  • "InventoryGroupTypeID": 568,
  • "InventoryID": 866,
  • "InventoryItemID": 764,
  • "IsPortedInNumber": true,
  • "LastModifiedDate": "2017-09-09T17:35:09.156Z",
  • "LastModifiedUser": "Username",
  • "NRUFCategory": "Assigned",
  • "NRUFSubcategory": "Local Routing Numbers",
  • "PortedFromServiceNumberOwner": "ServiceNumberOwner Name",
  • "PortedFromServiceNumberOwnerID": 467,
  • "PortedToServiceNumberOwner": "ServiceNumberOwner Name",
  • "PortedToServiceNumberOwnerID": 745,
  • "ReservationDetailID": 674,
  • "ServiceNumber": "My Service Number",
  • "Status": "Assigned",
  • "StatusChangeDate": "2017-09-09T17:35:09.156Z",
  • "StatusID": "11"
}

Inventory Item Result

A list of all the inventory items found as part of a FindAvailableServiceNumbers.

query Parameters
$count
number
Example: $count=3
  • 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 'Value'
  • 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.
$select
string
Example: $select=Name
  • 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
{
  • "AvailableDate": "2008-04-10T00:00:00.0000000",
  • "InventoryItem": "InventoryItem Value",
  • "InventoryItemID": 47,
  • "InventoryItemType": "MIN",
  • "InventoryItemTypeID": 2,
  • "IsPortedInNumber": false,
  • "PortedFromServiceNumberOwner": "My Service Number Owner",
  • "PortedFromServiceNumberOwnerID": 56854,
  • "ResultID": "My ResultID",
  • "Status": "Reserved",
  • "StatusChangeDate": "2017-09-09T17:35:09.156Z",
  • "StatusID": 9
}

Reservation Inventory Overview

A list of all the inventory reservations in the system.

query Parameters
$count
number
Example: $count=3
  • 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 'Value'
  • 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.
$select
string
Example: $select=Name
  • 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
{
  • "AccountNumber": "My Account Number",
  • "City": "Miami",
  • "CompanyName": "My Company Name",
  • "ContactID": 547,
  • "Country": "Australia",
  • "CustomerID": 3567,
  • "CustomerName": "My Customer Name",
  • "Email1": "primaryEmail@mail.com",
  • "Email1Type": "My Primary Email Type",
  • "FinalExpirationDate": "2017-09-09T17:35:09.156Z",
  • "FirstName": "Tony",
  • "Inventory": "My Inventory Name",
  • "InventoryID": 457,
  • "LastName": "Stark",
  • "OrderID": 357,
  • "OrderState": "My Order State",
  • "OrderStateID": 536,
  • "Phone1": "123-456-7891",
  • "Phone1Type": "My primary phone number type",
  • "ReservationDetailCount": 253,
  • "ReservationID": 357,
  • "State": "My State",
  • "Status": "In-Progress",
  • "Street1": "2354 Picasso Lane, old town, Minnesota",
  • "Street2": "445 Mount Eden Road, Mount Eden, Auckland",
  • "ZipCode": "12523"
}

Release Notes

Latest WSDL

Release Notes 2.06

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

Release Notes 2.05

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

Release Notes 2.04

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

Release Notes 2.03

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

Release Notes 2.02

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

Release Notes 2.01

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

Release Notes 2.00

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

Release Notes 1.08

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

Release Notes 1.07

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

Release Notes 1.06

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

Release Notes 1.05

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

Release Notes 1.04

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

Release Notes 1.03

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

Release Notes 1.02

  • WSDL
  • The AuthenticatedKey property is no longer used as the sole authorization of a user for a resource. Instead "limit-to" functionality will be enforced on every access call. Users who are not authorized for a resource but have a valid authorization key will no longer be allowed access to the resource and will need to be given appropriate access. Only the ID property will still be used.
  • Noted CustomerID change for CreateReservationReq and CreateReservationResult
  • Noted ReservationID change for ModifyReservationReq and ModifyReservationResult

Release Notes 1.01

  • WSDL
  • Added ReservationInventoryOverview to Core Data Service
  • Added OrderID, OrderState and OrderStateID to Reservation
  • Added AccountNumber, CustomerID, CustomerName, OrderID, OrderState, OrderStateID, ReservationOrderID, ReservationOrderState, ReservationOrderStateID, and ServiceInformationItemID to ReservationDetail