Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Sites

Returns a list of all sites configured in Crittah.

MethodResult
URIhttps://[CompanyID].crittah.com/ws/apiv2/[json or xml]/sites
GETReturns data for contact types

Data fields

FieldValue typeMandatoryDescriptionExample
IDSitestring 

...

Contact Types

...

Unique identifier of the site.7090fad1-c4da-4488-9ceb-55ee9847edcc
Sitestring Name of siteMelbourne
Descriptionstring description of siteThis is a description of the site

Get a contacts details

Sample cURL call:

Code Block
curl -H "Content-Type: application/json"  \
-H "API-AppID: 7090fad1-c4da-4488-9ceb-55ee9847edcc" \
-H "Api-Username: jsmith" \
-H "API-Password: abc123" \
http://[CompanyID].crittah.com/ws/apiv2/json/sites

JSON Rsponse:

Code Block
[
  {
    "IDSite": "d8eca573-9815-4bba-8ad5-235edde649ed",
    "Site": "ACT",
    "Description": "Canberra"
  },
  {
    "IDSite": "9b4d7590-1a69-47f9-bd37-8f0ab0655c32",
    "Site": "ADL",
    "Description": "Adelaide"
  },
  {
    "IDSite": "c374d0a9-b075-4084-bb3e-1d4d8d0610ab",
    "Site": "GC",
    "Description": "Gold Coast"
  }
]

XML Response: 

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfSiteObj xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <SiteObj>
      <IDSite>d8eca573-9815-4bba-8ad5-235edde649ed</IDSite>
      <Site>ACT</Site>
      <Description>Canberra</Description>
   </SiteObj>
   <SiteObj>
      <IDSite>9b4d7590-1a69-47f9-bd37-8f0ab0655c32</IDSite>
      <Site>ADL</Site>
      <Description>Adelaide</Description>
   </SiteObj>
   <SiteObj>
      <IDSite>c374d0a9-b075-4084-bb3e-1d4d8d0610ab</IDSite>
      <Site>GC</Site>
      <Description>Gold Coast</Description>
   </SiteObj>
</ArrayOfSiteObj>

Customer Types

 

Job Types 

Note Types

 

Contact Status

 

Customer Status

 

Users