PATCH api/order/Service/{OrderServiceID}/EndPointProperties

This API method updates a set of endpoint properties associated with 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.
  • 403/Forbidden - The OrderService ID 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 - The OrderService ID x requires a valid EndPoint to be set for property ID y - The Endpoint specified is not valid.
  • 403/Forbidden - Only the selected EndPointID x can be updated in OrderService ID y - Specify an Endpoint ID that is associated with the specified Order Service ID.
  • 404/Not Found - InventoryProperty ID x not found in OrderService ID y - The Inventory Property ID specified is not associated with the Order Service ID specified.
  • 403/Forbidden - EndPointID z, not found in OrderServiceID y, PropertyID z

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderServiceID The order service ID integer

Required

Body Parameters

List of EndPointPropertyUpdate

Collection of EndPointPropertyUpdate
NameDescriptionTypeAdditional information
EndPointID Endpoint ID integer

None.
WorkFlowMessage Run in the background, if the there is a failure, the workflow message will display the reason for the failure string

None.
InventoryPropertyID Property ID integer

None.
PropertyValue New value to be set string

None.
SubmitForProcessing Not used in this service boolean

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "EndPointID": 1,
    "WorkFlowMessage": "sample string 2",
    "InventoryPropertyID": 3,
    "PropertyValue": "sample string 4",
    "SubmitForProcessing": true
  },
  {
    "EndPointID": 1,
    "WorkFlowMessage": "sample string 2",
    "InventoryPropertyID": 3,
    "PropertyValue": "sample string 4",
    "SubmitForProcessing": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfEndPointPropertyUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models">
  <EndPointPropertyUpdate>
    <InventoryPropertyID>3</InventoryPropertyID>
    <PropertyValue>sample string 4</PropertyValue>
    <SubmitForProcessing>true</SubmitForProcessing>
    <EndPointID>1</EndPointID>
    <WorkFlowMessage>sample string 2</WorkFlowMessage>
  </EndPointPropertyUpdate>
  <EndPointPropertyUpdate>
    <InventoryPropertyID>3</InventoryPropertyID>
    <PropertyValue>sample string 4</PropertyValue>
    <SubmitForProcessing>true</SubmitForProcessing>
    <EndPointID>1</EndPointID>
    <WorkFlowMessage>sample string 2</WorkFlowMessage>
  </EndPointPropertyUpdate>
</ArrayOfEndPointPropertyUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.