PATCH api/order/Service/{OrderServiceID}/EndPoint/{EndPointID}

This API method updates an existing endpoint on an order service

Error Messages
  • 500/Internal Server Error - Error getting order service record with id x
  • 404/Not Found - No order service found with id x - Specified ID does not match an existing Order Service.
  • 404/Not Found - EndPoint record with id x not found in OrderServiceID y - Specified Endpoint ID is not associated with the specified Order Service ID.
  • 403/Forbidden - The OrderServiceID x is not a service that supports endpoints - The service assigned to this order does not support endpoints. Select one that does to assign an Endpoint to this order.
  • 403/Forbidden - Loopback IP address is forbidden - 127.0.0.1 (or any other loopback IP) can't be used as the Endpoint IP address.
  • 403/Forbidden - The endpoint name is already being used for OrderServiceID - The specified Endpoint name is already in use. Please specify another.
  • 500/Internal Server Error - EndpointID x updated failed, WorkFlow returned a message on OrderServiceID z.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderServiceID The order service ID integer

Required
EndPointID The ID of the EndPoint that will be updated integer

Required

Body Parameters

patch object

EndPointBase
NameDescriptionTypeAdditional information
Name Mandatory -unique reference name for endpoint string

Required

String length: inclusive between 0 and 200
CustomerName Mandatory - customer reference string

Required

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

Required

String length: inclusive between 0 and 16
Premises Mandatory address field string

Required

String length: inclusive between 0 and 255
Thoroughfare Mandatory address field string

Required

String length: inclusive between 0 and 255
Locality Mandatory address field string

Required

String length: inclusive between 0 and 50
County Mandatory address field string

Required

String length: inclusive between 0 and 50
PostCode Mandatory address field 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/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.