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

This API method will update the value of any inventory items contained in an order service

Notes

  • Must have OrderServiceID
  • You can only PATCH to: Textbox, Dropdown,Checkbox, MultilineTextbox
  • PATCH to checkbox must be boolean or true/false
  • Text strings are nullable
  • CP can patch after submission; Reseller cannot unless in editable state (in the quote stage)
  • ServiceInventoryProperties item must be isAgentVisible for reseller/agent
Error Messages
  • 500/Internal Server Error - Error retrieving the Order Service with ID x.
  • 404/NotFound - OrderServiceID x not found - Specified ID does not match any existing Services.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderServiceID Service ID from an existing order or quote integer

Required

Body Parameters

list of ModifyOrderServiceProperties to be updated

Collection of ModifyOrderServiceProperties
NameDescriptionTypeAdditional information
InventoryPropertyID Idenfitier for the inventory item to be updated integer

None.
PropertyValue Value that will be saved for inventory item string

None.
SubmitForProcessing If set to true will submit order service for processing this will disable any further edits unless there is a problem that requires an further edit boolean

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.