POST Company

The POST Company API allows you to create 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. 

CONTENTS

• POST Request
• POST Response
• API Usage Example

POST Request

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 format query string parameter controls the desired response format.  Specify either XML or JSON.

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

The required (red border) and optional parameters for a POST to the Company API are outlined below.

Model Schema

Note, that if you wish to automatically create a support user for your internal use with this Company, you should set the AddSupportUser property on Company to be True.
 

POST Response

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

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 POST example which creates a new Company for the specified Vendor using XML format.

XML Body:

<Company>
 <ActiveDevices>0</ActiveDevices>
 <ActiveUsers>0</ActiveUsers>
 <AddSupportUser>True</AddSupportUser>
 <Country>GB</Country>
 <Description>Test Org</Description> 
 <DateFormat>dd-MMM-yyyy</DateFormat>
 <DefaultSenderEmail>test@myorg.com</DefaultSenderEmail>
 <DefaultSenderName>Test Company</DefaultSenderName>
 <DeviceLimit>0</DeviceLimit>
 <GlobalFormPOSTURL></GlobalFormPOSTURL>
 <GlobalHostedGETURL></GlobalHostedGETURL>
 <GlobalTaskPOSTURL></GlobalTaskPOSTURL>
 <IntegrationKey>xxx</IntegrationKey>
 <Name>Test Company</Name> 
 <VendorId>1</VendorId>
 <TimeFormat>HH:mm</TimeFormat>
 <TimeZone>GMT Standard Time</TimeZone>
 <UserLimit>0</UserLimit>
 </Company>

XML Response:        

<CompanyResponse>
 <ResponseStatus />
 <Company>
 <Id>2</Id>
 <IntegrationKey>xxx</IntegrationKey>
 <Status>Active</Status>
 <VendorId>1</VendorId>
 </Company> 
 <SupportUser>
  <Email>2$test@myorg.com</Email>
  <FirstName>Test Company</FirstName>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <LastActivity>0001-01-01T00:00:00</LastActivity>
  <LastName>Support</LastName>
  <CompanyId>2</CompanyId>
  <Status>Invited</Status>
 </SupportUser>
 </CompanyResponse>