POST api/order/Service/{OrderServiceID}/PortNumber

This method allows you to add Port Numbers to the specified Order Service. Note that, you do not need to send an associated number. If you set an associate number and there is no range, the qunaity is set to 1 and the associated numbers are nullable

There are a number of reasons why adding Port Numbers to an Order Service may fail. These are:

  • OrderServices.OrderServiceID = Error retrieving the Order Service with ID X.
  • 403/Forbidden - Only quotes may be updated - The specified ID is assigned to an order and note a quote. Only Quotes can be updated.
  • 403/Forbidden - PortAction value is not valid in OrderServiceID x - This action cannot be performed on this Order Service.
  • 403/Forbidden - OrderServiceID x must contain a PortingNumber control - This Order Service must contain a Porting Number control.
  • Order.PortNumber = The number range submitted overlaps with another range on the same service.
  • PortNumber.Quantity = Quantity must be between 1 and X - Quantity must be between 1 and the number specified for this service on the service deisgner.
  • PortNumber.Quantity = Quantity for the whole service may not be more than X, including this operation it will be X - Quantity must be between 1 and the number specified for this service on the service deisgne.r
  • 403/Forbidden - When porting an associated number the maximum quantity allowed is 1 - Only 1 associated number can be ported at a given time.
  • PortNumber.FirstNumber = When porting an associated number the FirstNumber must be the same as the AssociatedNumber - Ensure that the Firstname is the same as the specified associated number.
  • PortNumbers.ID = Error saving numbers.
  • 403/Forbidden - When porting a range the quantity must be 1 or greater - When importing a range of numbers, the Quantity must be greater than 1.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderServiceID The unique identifer for the Order to have additional Port numbers added. integer

Required

Body Parameters

PortNumberBase

PortNumberCreate
NameDescriptionTypeAdditional information
AssociatedNumber The number associated with the method string

None.

Quantity Number of CLIs in range integer

None.

FirstNumber First CLI in range string

String length: inclusive between 0 and 17

LastNumber The last CLI in the range string

String length: inclusive between 0 and 17

PortAction Enum, either `Port` or `Cease` PortNumberActions

None.

Request Formats

application/json, text/json

Sample:
{
  "AssociatedNumber": "sample string 1",
  "Quantity": 1,
  "FirstNumber": "sample string 2",
  "LastNumber": "sample string 3",
  "PortAction": "Port"
}

application/xml, text/xml

Sample:
<PortNumberCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <FirstNumber>sample string 2</FirstNumber>
  <LastNumber>sample string 3</LastNumber>
  <PortAction>Port</PortAction>
  <Quantity>1</Quantity>
  <AssociatedNumber>sample string 1</AssociatedNumber>
</PortNumberCreate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PortNumberView

PortNumberView
NameDescriptionTypeAdditional information
PortNumberID The Port Number ID integer

None.

Quantity The total of Port Numbers. This specifies the range size integer

None.

FirstNumber The First number in the range string

String length: inclusive between 0 and 17

LastNumber The last number in the range string

String length: inclusive between 0 and 17

PortAction The status of the Port Number PortNumberActions

None.

Response Formats

application/json, text/json

Sample:
{
  "PortNumberID": 1,
  "Quantity": 1,
  "FirstNumber": "sample string 2",
  "LastNumber": "sample string 3",
  "PortAction": "Port"
}

application/xml, text/xml

Sample:
<PortNumberView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <FirstNumber>sample string 2</FirstNumber>
  <LastNumber>sample string 3</LastNumber>
  <PortAction>Port</PortAction>
  <Quantity>1</Quantity>
  <PortNumberID>1</PortNumberID>
</PortNumberView>