POST api/orders/availablenumbers

Retrieves a list of available phone numbers of the specified type.

Request Information

URI Parameters

None.

Body Parameters

An object specifying the type of number to search for and optionally a start and end sequence filter.

Name	Type	Additional information
NumberType	SubscriptionCategories	None.
SequenceStart	string	None.
SequenceEnd	string	None.
Limit	integer	None.
ProductPackageId	integer	None.
SiteId	integer	None.
NetworkOperatorId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "NumberType": 1,
  "SequenceStart": "sample string 1",
  "SequenceEnd": "sample string 2",
  "Limit": 3,
  "ProductPackageId": 4,
  "SiteId": 5,
  "NetworkOperatorId": 6
}

text/html

Sample:

{"NumberType":1,"SequenceStart":"sample string 1","SequenceEnd":"sample string 2","Limit":3,"ProductPackageId":4,"SiteId":5,"NetworkOperatorId":6}

application/xml, text/xml

Sample:

<OrdersController.PhoneNumberSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LimitlessMobile.WebAPI.Controllers">
  <Limit>3</Limit>
  <NetworkOperatorId>6</NetworkOperatorId>
  <NumberType>Mobile</NumberType>
  <ProductPackageId>4</ProductPackageId>
  <SequenceEnd>sample string 2</SequenceEnd>
  <SequenceStart>sample string 1</SequenceStart>
  <SiteId>5</SiteId>
</OrdersController.PhoneNumberSearch>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of available phone numbers.

Collection of PhoneNumber

Name	Description	Type	Additional information
GroupId		integer	None.
Msisdn		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "GroupId": 1,
    "Msisdn": "sample string 1"
  },
  {
    "GroupId": 1,
    "Msisdn": "sample string 1"
  }
]

text/html

Sample:

[{"GroupId":1,"Msisdn":"sample string 1"},{"GroupId":1,"Msisdn":"sample string 1"}]

application/xml, text/xml

Sample:

<ArrayOfPhoneNumber xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PhoneNumber>
    <GroupId>1</GroupId>
    <Msisdn>sample string 1</Msisdn>
  </PhoneNumber>
  <PhoneNumber>
    <GroupId>1</GroupId>
    <Msisdn>sample string 1</Msisdn>
  </PhoneNumber>
</ArrayOfPhoneNumber>