PATCH api/company/{CompanyID}/Property

This API updates thecustom entity properties of a company

Error Messages
  • 404/Not Found - Error retrieving Company with id x
  • 404/Not Found - Company with id x not found - ID does not match with any company
  • 404/Not Found - Company with id x is not of the correct type to update custom properties
  • 404/Not Found - Unable to process properties for CompanyID x

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyID The Company to be updated integer

Required

Body Parameters

EntityCustomPropertyModify

Collection of EntityCustomPropertyModify
NameDescriptionTypeAdditional information
ControlID The Control ID string

None.
PropertyValue New value string

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "ControlID": "sample string 1",
    "PropertyValue": "sample string 2"
  },
  {
    "ControlID": "sample string 1",
    "PropertyValue": "sample string 2"
  }
]

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.