Loading...

REST API - PUT Organization Details

This operation updates an organization.

Request

Syntax

PUT <webservice>/Organization HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/xml

<update_organization_template.xml>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Request Body

Download the XML file required for this request: update_organization_template.xml. The following table displays the parameters for the request body.

Parameter

Description

Element

Parent Element

planDetailsOperationType

The operation to perform on the plan associated with the organization.

Valid values:

  • ADD
  • OVERWRITE
  • DELETE

organizationInfo

Api_UpdateOrganizationPropertiesRequest

planName

The name of the associated plan.

plan

planDetails

defaultPlansOperationType

The operation to perform on the default plan.

Valid values:

  • ADD
  • OVERWRITE
  • DELETE

organizationProperties

organizationInfo

planName

The name of the default plan.

plan

defaultPlans

domainName

The name of the organization.

shortName

organization

id

The system-generated ID assigned to the organization. If the organization ID is not known, use the GET Organization API to retrieve it. The organization ID is the ID in the shortName element.

shortName

organization

Response

Response Parameters

Parameter

Description

Element

errorMessage

The description of the error code. Not all error codes have an error message.

error

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.

error

Examples

Sample Request

This request associates a plan with an organization.

PUT <webservice>/Organization HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<Api_UpdateOrganizationPropertiesRequest>
  <organizationInfo planDetailsOperationType="ADD">
    <planDetails>
      <plan planName="Laptop plan" />
    </planDetails>
    <organization>
      <shortName domainName="company001" id="1" />
    </organization>
  </organizationInfo>
</Api_UpdateOrganizationPropertiesRequest>

This request sets a default plan for an organization.

PUT <webservice>/Organization HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<Api_UpdateOrganizationPropertiesRequest>
  <organizationInfo>
    <organization>
      <shortName domainName="company001" id="1" />
    </organization>
    <organizationProperties defaultPlansOperationType="ADD">
      <defaultPlans>
        <plan planName="Laptop plan" />
      </defaultPlans>
    </organizationProperties>
  </organizationInfo>
</Api_UpdateOrganizationPropertiesRequest>

Sample Response

{
  "error": {
    "errorMessage": "",
    "errorCode": 0
 }
}

Last modified: 4/23/2020 6:18:53 AM