Groups

List Groups

URL:

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

Example

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

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

Sample Response

<groups>
  <group>
    <id>1323029071794009</id>
    <name>group1</name>
  </group>
  <group>
    <id>1323029079332010</id>
    <name>group2</name>
  </group>
</groups>

In this example, group1’s ID is 1323029071794009.

Get Single Group

URL:

http://www.ihelpdesk.com/desktop/api/{SITE_NAME}/groups/{group-ID}

Example

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

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

Create Group

URL:

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

HTTP Method: POST

Content Type: application/xml

Request Body

<group>
    <name>{NEW_GROUP_NAME}</name>
</group>

Example

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

curl -u joe@acme.com:joe -H “Content-Type: application/xml” -d “<group><name>group3</name></group>” -X POST http://www.ihelpdesk.com/desktop/api/acme/groups

Update Group

URL:

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

HTTP Method: PUT

Content Type: application/xml

Request Body

<group>
     <name>{NEW_GROUP_NAME}</name>
</group>

Example

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

curl -H “Content-Type: application/xml” -u joe@acme.com:joe -X PUT -d “<group><name>test2</name></group>” http://ihelpdesk.com/desktop/api/acme/groups/1322875450186003

Delete Group

URL:

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

HTTP Method: DELETE

Example

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

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