Follow

PUT Company

The Company API allows you to retrieve, create and delete client Companies on the platform. 
This enables scenarios where Companies created/maintained in other systems (e.g. SAP, Salesforce) can be replicated to the platform automatically.

On our Cloud service, this API is available via SSL secured HTTPS connection using the REST GET, POST and PUT verbs.
The format query string parameter controls the desired response format.  Specify either xml or json.

/api/v2/company?format=xml/json

 

PUT Request

The PUT verb allows you to update a single, existing Company on the platform.

You may use either JSON or XML formats in your request. 
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml". If no ContentType is specified, XML format is assumed.

The required and optional parameters for a PUT to the Company API are outlined below.

Parameter Name

Data Type

Required

Description

Company

Company

Yes

The Company that you wish to update.  See the Company type definition from the GET documentation topic.

 

PUT Response

The data returned from a Company PUT is provided as follows:

Company Response (<CompanyResponse>)

Field Name

Data Type

Description

Company

 

Company

 

The Company updated.

ResponseStatus

ResponseStatus

Details of any errors that may have occurred


Company (<
Company>) Response Fields

The Company returned is only populated with the following fields:

Field Name

Data Type

Description

Id

Integer

The Company's unique identifier

Status

String

Status of this Company.

 
IntegrationKey

String  The Companys unique integration key
 
VendorId

Integer  The Master Company's Id to which the updated Company belongs

 

API Usage Example

Given that the API is REST based, you can access the API directly via your web browser to test it.  Obviously for actual integration works, you will need to make a web request to the given REST URL and then parse the response.

Below is a simple PUT example which updates an existing Company, using XML format.

<Company>
<ActiveUsers>4</ActiveUsers
<Id>2</Id>
<IntegrationKey>xxx</IntegrationKey>
<Name>Test Company</Name
<VendorId>1</VendorId>
</Company>
 

XML Response

<CompanyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

<ResponseStatus/>
<Company>
<Id>2</Id>
<IntegrationKey>xxx</IntegrationKey>
<Status>Active</Status>
<VendorId>1</VendorId>
</Company>
</CompanyResponse>
 

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk