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

This API method creates a new endpoint and adds it to an existing order service. The created EndPoint will not be provisioned until the order is submitted thus the Endpoint will not returned when using the GET\api\site\SiteID\EndPoint method instead use the GET\api\site\SiteID\EndPoint\EndPointID

    Notes:
  • Endpoint must exist on that service
  • Endpoint can be edited in a provisioned state
  • Endpoint does not need to be selected on the service in order to be edited
  • The name of the Endpoint must be unique
  • When adding an endpoint using the POST\api\order\Service\OrderServiceID\EndPoint method, the ID of the endpoint is returned to you in the response
  • If TTB is selected as the provider then the reference must be entered
Error Messages
  • 500/Internal Server Error - Error getting order service record with id x.
  • 404/NotFound - No order service found with id x - ID of Order Service specified does not exist.
  • 403/Forbidden - Only quotes may be updated - The ID specified is assigned to an order.
  • 403/Forbidden - The OrderServiceID x is not a service that supports endpoints - The specified Order Service ID does not support Endpoints.
  • 403/Forbidden - The OrderServiceID x endpoint control is disabled.
  • 403/Forbidden - The OrderServiceID x endpoint editing is disabled as the order is locked.
  • 403/Forbidden - The OrderServiceID x endpoint creation control has been disabled.
  • 403/Forbidden - Loopback IP address is forbidden.
  • 403/Forbidden - There are errors in the submission x.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderServiceID The order service ID integer

Required

Body Parameters

new endpoint to be created

EndPointBase
NameDescriptionTypeAdditional information
Name Unique reference name for endpoint string

Required

String length: inclusive between 0 and 200
CustomerName Customer reference string

Required

String length: inclusive between 0 and 255
IPAddress IP Address of end point - do not use 127.0.0.1 string

Required

String length: inclusive between 0 and 16
Premises The premise location associated with the End Point string

Required

String length: inclusive between 0 and 255
Thoroughfare The street name string

Required

String length: inclusive between 0 and 255
Locality The locality associated with the End Point. Likely to be similar to county string

Required

String length: inclusive between 0 and 50
County The County associated with the End Point string

Required

String length: inclusive between 0 and 50
PostCode The postcode associated with the End Point string

Required

String length: inclusive between 0 and 20
Country string

Required

String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "CustomerName": "sample string 2",
  "IPAddress": "sample string 3",
  "Premises": "sample string 4",
  "Thoroughfare": "sample string 5",
  "Locality": "sample string 6",
  "County": "sample string 7",
  "PostCode": "sample string 8",
  "Country": "sample string 9"
}

application/xml, text/xml

Sample: 
<EndPointBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <Country>sample string 9</Country>
  <County>sample string 7</County>
  <CustomerName>sample string 2</CustomerName>
  <IPAddress>sample string 3</IPAddress>
  <Locality>sample string 6</Locality>
  <Name>sample string 1</Name>
  <PostCode>sample string 8</PostCode>
  <Premises>sample string 4</Premises>
  <Thoroughfare>sample string 5</Thoroughfare>
</EndPointBase>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ID of new endpoint

EndPointCreateResponse
NameDescriptionTypeAdditional information
EndPointID Newly created end point ID integer

None.
WorkFlowMessage Any messages from the Workflow string

None.

Response Formats

application/json, text/json

Sample: 
{
  "EndPointID": 1,
  "WorkFlowMessage": "sample string 2"
}

application/xml, text/xml

Sample: 
<EndPointCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <EndPointID>1</EndPointID>
  <WorkFlowMessage>sample string 2</WorkFlowMessage>
</EndPointCreateResponse>