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

Returns a list of Port numbers on a specified Service

Error Messages
  • 500/Internal Server Error - Error retrieving the Order Service with ID x.
  • 404/Not Found - OrderServiceID x not found - Specified Order Service ID does not exist.
  • 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
  • 403/Forbidden - When porting an associated number the maximum quantity allowed is 1 - Only 1 associated number can be ported at a given time
  • 403/Forbidden - When porting an associated number the FirstNumber must be either null, or the same as the AssociatedNumber
  • 403/Forbidden - When porting a range the quantity must be 1 or greater
  • 403/Forbidden - The number range submitted overlaps with another range on the same service
  • 403/Forbidden - Quantity must be between 1 and x
  • 403/Forbidden - Quantity for the whole service may not be more than x, including this operation it will be y
  • 500/Internal Server Error - Error saving numbers
  • ––>

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderServiceID The unique identifer for the Order to search for Port Numbers. integer

Required

Body Parameters

None.

Response Information

Resource Description

List of 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.