Organizations

List Organizations

URL:

http://www.ihelpdesk.com/desktop/api/{SITE_NAME}/organizations

Example

Suppose your iHelpdesk site name is acme, with organization name being joe@acme.com and password being joe.

curl -u joe@acme.com:joe http://www.ihelpdesk.com/desktop/api/acme/organizations

Sample Response

<organizations>
  <organization>
    <id>1323029071794009</id>
    <name>organization1</name>
  </organization>
  <organization>
    <id>1323029079332010</id>
    <name>organization2</name>
  </organization>
</organizations>

In this example, organization1’s ID is 1323029071794009.

Get Single Organization

URL:

http://www.ihelpdesk.com/desktop/api/{SITE_NAME}/organizations/{organization-ID}

Example

Suppose your iHelpdesk site name is acme, with organization name being joe@acme.com and password being joe.

curl -u joe@acme.com:joe http://www.ihelpdesk.com/desktop/api/acme/organizations/1321279825848036

Create Organization

URL:

http://www.ihelpdesk.com/desktop/api/{SITE_NAME}/organizations

HTTP Method: POST

Content Type: application/xml

Request Body

<organization>
    <name>{ORGANIZATION_NAME}</name>
     <description>more details</description>
     <group>
        <id>{GROUP_ID}</id>
     </group>
     <domains>
         <domain>
             <name>mycompany</name>
         </domain>
     </domains>
     <public>{true|false}</public>
</organization>

Notes

Organization name and domain names must be unique and cannot conflict with existing ones.

Example

Suppose your iHelpdesk site name is acme, with organization name being joe@acme.com and password being joe.

curl -u joe@acme.com:joe -H “Content-Type: application/xml” -d “<organization><name>org31</name><description>org3’s description</description><group><id>1323029079332010</id></group><domains><domain><name>org31.com</name></domain></domains><public>true</public></organization>” -X POST http://www.ihelpdesk.com/desktop/api/acme/organizations

Update Organization

URL:

http://www.ihelpdesk.com/desktop/api/{SITE_NAME}/organizations/{organization_ID}

HTTP Method: PUT

Content Type: application/xml

Request Body

<organization>
    <name>{ORGANIZATION_NAME}</name>
     <description>more details</description>
     <group>
        <id>{GROUP_ID}</id>
     </group>
     <domains>
         <domain>
             <name>mycompany</name>
         </domain>
     </domains>
     <public>{true|false}</public>
</organization>

Example

Suppose your iHelpdesk site name is acme, with organization name being joe@acme.com and password being joe.

curl -H “Content-Type: application/xml” -u joe@acme.com:joe -X PUT -d “<organization><name>org31</name><description>org3’s description</description><group><id>1323029079332010</id></group><domains><domain><name>org31.com</name></domain></domains><public>true</public></organization>” http://ihelpdesk.com/desktop/api/acme/organizations/1322875450186003

Delete Organization

URL:

http://www.ihelpdesk.com/desktop/api/{SITE_NAME}/organizations/{organization_ID}

HTTP Method: DELETE

Example

Suppose your iHelpdesk site name is acme, with organization name being joe@acme.com and password being joe.

curl -u joe@acme.com:joe -X DELETE http://www.ihelpdesk.com/desktop/api/acme/organizations/1322623923854043