POST /api/v1/organisations.xml
Creates an organisation

Example request to server ↑

curl -X POST https://xmlagri.qcone.com/api/v1/organisations.xml \
  --user :api_key \
  --data '<?xml version="1.0" encoding="UTF-8"?>
<organisation>
  <customerId>ABC123</customerId>
  <name>Name of the company</name>
  <countryCode>GB</countryCode>
  <isActive>false</isActive>
</organisation>'

Example response from server ↑

<?xml version="1.0" encoding="UTF-8"?>
<organisation>
  <id>19167</id>
  <customerId>ABC123</customerId>
  <name>Name of the company</name>
  <countryCode>GB</countryCode>
  <isActive>false</isActive>
</organisation>

Params

Param name Description
code
optional

Customer Code

Validations:

  • Must be String
name
required

Name of the organisation

Validations:

  • Must be String
countryCode
optional

Code of the organisation's country - ISO 3166/alpha2

Validations:

  • Must be String
isActive
optional

True when organisation has to have access to QCOne. False when no access is needed

Validations:

  • Must be 'true' or 'false' or '1' or '0'
email
optional

Email of the admin account of the organisation. Required when isActive is True

Validations:

  • Must be String
notificationEmailCode
optional

Single notification mail code

Validations:

  • Must be String