REST-UserOrganization
This topic provides details about the REST - UserOrganization API call that GFI HelpDesk uses, including its field types, arguments, and responses.
GET /Base/UserOrganization
Retrieve a list of all organizations in the help desk.
Response
<userorganization>
<id>1</id>
<name>GFI HelpDesk.</name>
<organizationtype>restricted</organizationtype>
<address>2nd Floor, Midas Corporate Park, 37 GT Road</address>
<city>Jalandhar</city>
<state>Punjab</state>
<postalcode>144001</postalcode>
<country>India</country>
<phone /><fax /><website>http://www.kayako.com</website>
<!-- Timeline Properties --><dateline>1296540309</dateline>
<lastupdate>1296540309</lastupdate>
<!-- Custom SLA Properties --><slaplanid>0</slaplanid>
<slaplanexpiry>0</slaplanexpiry>
</userorganization>
</userorganizations>
GET /Base/UserOrganization/$id$
Retrieve the user organization identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ | The unique numeric identifier of the user organization |
Response
<userorganization>
<id>1</id>
<name>GFI HelpDesk.</name>
<organizationtype>restricted</organizationtype>
<address>2nd Floor, Midas Corporate Park, 37 GT Road</address>
<city>Jalandhar</city>
<state>Punjab</state>
<postalcode>144001</postalcode>
<country>India</country>
<phone />
<fax /><website>http://www.kayako.com</website>
<!-- Timeline Properties --><dateline>1296540309</dateline>
<lastupdate>1296540309</lastupdate>
<!-- Custom SLA Properties --><slaplanid>0</slaplanid>
<slaplanexpiry>0</slaplanexpiry>
</userorganization>
</userorganizations>
PUT /Base/UserOrganization/$id$
Update the user organization identified by $id$.
Arguments
| Name | Description |
|---|---|
| name | The name of the user organization |
| organizationtype | The type of user organization ('restricted' or 'shared') |
| address | |
| city | |
| state | |
| postalcode | |
| country | |
| phone | |
| fax | |
| website | |
| slaplanid | The SLA Plan ID to link with this organization |
| slaplanexpiry | The UNIX timestamp by which to ignore the SLA Plan, 0 = never expires |
Response
<userorganization>
<id>1</id>
<name>GFI HelpDesk.</name>
<organizationtype>restricted</organizationtype>
<address>2nd Floor, Midas Corporate Park, 37 GT Road</address>
<city>Jalandhar</city>
<state>Punjab</state>
<postalcode>144001</postalcode>
<country>India</country>
<phone /><fax /> <website>http://www.kayako.com</website>
<!-- Timeline Properties --><dateline>1296540309</dateline>
<lastupdate>1296540309</lastupdate>
<!-- Custom SLA Properties -->
<slaplanid>0</slaplanid>
<slaplanexpiry>0</slaplanexpiry>
</userorganization>
</userorganizations>
POST /Base/UserOrganization
Create a new user organization record.
Arguments
| Name | Description |
|---|---|
| name | The name of the user organization. |
| organizationtype | The type of user organization('restricted'or'shared') |
| address | |
| city | |
| state | |
| postalcode | |
| country | |
| phone | |
| fax | |
| website | |
| slaplanid | The SLA Plan ID to link with this organization |
| slaplanexpiry | The UNIX timestamp by which to ignore the SLA Plan, 0 = never expires |
Response
<userorganization>
<id>1</id>
<name>GFI HelpDesk.</name>
<organizationtype>restricted</organizationtype>
<address>2nd Floor, Midas Corporate Park, 37 GT Road</address>
<city>Jalandhar</city>
<state>Punjab</state>
<postalcode>144001</postalcode>
<country>India</country>
<phone /><fax /> <website>http://www.kayako.com</website>
<!-- Timeline Properties -->
<dateline>1296540309</dateline>
<lastupdate>1296540309</lastupdate>
<!-- Custom SLA Properties --><slaplanid>0</slaplanid>
<slaplanexpiry>0</slaplanexpiry>
</userorganization>
</userorganizations>
DELETE /Base/UserOrganization/$id$
Delete the user organization identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ |
The unique numeric identifier of the user organization |