Field	Value type	Description	Example
IDSite	string		Unique identifier of the site.	7090fad1-c4da-4488-9ceb-55ee9847edcc
Site	string	Name of site	Melbourne
Description	string		description of site	This is a description of the site

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>

Anchor

...

LeadSourceTypes

...

LeadSourceTypes

...

Lead Sources

Returns a list of all customer types lead sources configured in Crittah.

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/types/customerleadsources
GET	Returns data defining customer types

...

Field	Value type	Description	Example
IDType	string		Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
TypeName	string	Name of type	VIPPhone
Description	string		description of typeVery important customer	Lead generated by phone.

Get customer types

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/types/customerleadsources

JSON Rsponse:

Code Block

[ 
  {
    "IDType": "4d819963-731c-41fd-9378-fd7a10199b78",
    "TypeName": "AssociatesPhone",
    "Description": "AssociatesLead generated by phone"
  },
  {
    "IDType": "81c3c93e-fed4-4491-81d2-b9c8e6de5fac",
    "TypeName": "Bulk deliveryWeb",
    "Description": "BulkWeb deliveryLead"
  },
  {
    "IDType": "101f4545-d10c-4bd5-a8b5-325258968649",
    "TypeName": "GeneralReferral",
    "Description": "General CustomerReferral from existing customer"
  },
  {
    "IDType": "eac9f42e-8fd9-4b03-97fe-fd870c75aab1",
    "TypeName": "Receiver",
    "Description": "Receiver"
  }
]

...

XML Response:

Code Block

<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfTypeCrittah xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <TypeCrittah>
      <IDType>81c3c93e-fed4-4491-81d2-b9c8e6de5fac</IDType>
      <TypeName>Bulk delivery<<TypeName>Web</TypeName>
      <Description>Bulk<Description>Web delivery<Lead</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>101f4545-d10c-4bd5-a8b5-325258968649</IDType>
      <TypeName>General<<TypeName>Referral</TypeName>
      <Description>Referral from existing <Description>General<customer</Description>
   </TypeCrittah>

  <TypeCrittah>
      <IDType>eac9f42e-8fd9-4b03-97fe-fd870c75aab1</IDType>
      <TypeName>Receiver</TypeName>
      <Description>Receiver</Description>
   </TypeCrittah>
</ArrayOfTypeCrittah></ArrayOfTypeCrittah>

Anchor

...

CustomerTypes

...

CustomerTypes

...

Customer Types

Returns a list of all contact customer types configured in Crittah.

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/types/contactcustomer
GET	Returns data defining contact customer types

Data fields

Field	Value type	Description	Example
IDType	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
TypeName	string		Name of type	VIP
Description	string		description of type	Very important customer

Get

...

customer types

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/types/contactcustomer

JSON Rsponse:

Code Block

[ 
  {
    "IDType": "7e56478b4d819963-70ab731c-4b8c41fd-aa0d9378-c4729f98ccb2fd7a10199b78",
    "TypeName": "AccountsAssociates",
    "Description": "AccountsAssociates"
  },
  {
    "IDType": "2e55483881c3c93e-1291fed4-46054491-8e6481d2-dc97104a216eb9c8e6de5fac",
    "TypeName": "CEOBulk delivery",
    "Description": "CEOBulk delivery"
  },
  {
    "IDType": "cbc1ad16101f4545-01cdd10c-424a4bd5-900ca8b5-45ccc8f630c3325258968649",
    "TypeName": "General",
    "Description": "General Customer"
  }
]

XML Response:

Code Block
<?xml version="1.0" encoding="UTF-8"?> <ArrayOfTypeCrittah xmlns, { "IDType": "eac9f42e-8fd9-4b03-97fe-fd870c75aab1", "TypeName": "Receiver", "Description": "Receiver" } ]

XML Response:

Code Block

<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfTypeCrittah xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <TypeCrittah>
      <IDType>7e56478b<IDType>81c3c93e-70abfed4-4b8c4491-aa0d81d2-c4729f98ccb2<b9c8e6de5fac</IDType>
      <TypeName>Accounts<<TypeName>Bulk delivery</TypeName>
      <Description>Bulk <Description>Accounts<delivery</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>2e554838<IDType>101f4545-1291d10c-46054bd5-8e64a8b5-dc97104a216e<325258968649</IDType>
      <TypeName>CEO<<TypeName>General</TypeName>
      <Description>CEO<<Description>General</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>cbc1ad16<IDType>eac9f42e-01cd8fd9-424a4b03-900c97fe-45ccc8f630c3<fd870c75aab1</IDType>
      <TypeName>General<<TypeName>Receiver</TypeName>
      <Description>General<<Description>Receiver</Description>
   </TypeCrittah>
</ArrayOfTypeCrittah>

Anchor

...

ContactTypes

...

ContactTypes

...

Contact Types

Returns a list of all job contact types configured in Crittah.

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/types/jobcontact
GET	Returns data defining job contact types

Data fields

Field	Value type	Description	Example
IDJobTypeIDType	string		Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
IDWorkFlowTypeName	string	ID of the workflow used for the specific job type.	jdk0fad1-c4da-4488-ereb-55ee9847edcc
Name	string	Name of job	AdHoc
Descr	string	Description of job	AdHoc job used for last minute work
Colour	string	HEX colour used to colour code the job	#hhjkgf

...

	Name of type	VIP
Description	string		description of type	Very important customer

Get contact types

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/types/jobcontact

JSON Rsponse:

Code Block

[
  {
    "IDJobTypeIDType": "49b86bf87e56478b-a61070ab-45944b8c-baeaaa0d-30b76c21974dc4729f98ccb2",
    "IDWorkFlowTypeName": "7381887c-3fd5-49b0-896c-06b692efbb59Accounts",
    "NameDescription": "AdHocAccounts"
  },
  {
    "DescrIDType": "A non scheduled job.2e554838-1291-4605-8e64-dc97104a216e",
    "TypeName": "CEO",
    "ColourDescription": "#f5c9cbCEO"
  },
  {
    "IDJobTypeIDType": "023850a1cbc1ad16-ac5601cd-47f5424a-a90a900c-8ec48c34630545ccc8f630c3",
    "IDWorkFlowTypeName": "7381887c-3fd5-49b0-896c-06b692efbb59General",
    "NameDescription": "Drop OffGeneral",
  }
]

XML Response:

Code Block

<?xml version="Descr1.0": "Scheduled and non scheduled delivery items to customer. ",
    "Colour": "#faf59b"
  },
  {
    "IDJobType": "bd176be9-8c1b-4cd3-9b54-5ad51b2de3f4",
    "IDWorkFlow": "7381887c-3fd5-49b0-896c-06b692efbb59",
    "Name": "Pickup",
    "Descr": "A scheduled collection. ",
    "Colour": "#99CCFF"
  }
]

XML Response:

Code Block

<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfJobTypeObj xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <JobTypeObj>
      <IDJobType>49b86bf8-a610-4594-baea-30b76c21974d</IDJobType>encoding="UTF-8"?>
<ArrayOfTypeCrittah xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <TypeCrittah>
      <IDType>7e56478b-70ab-4b8c-aa0d-c4729f98ccb2</IDType>
      <TypeName>Accounts</TypeName>
      <Description>Accounts</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>2e554838-1291-4605-8e64-dc97104a216e</IDType>
      <TypeName>CEO</TypeName>
      <Description>CEO</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDWorkFlow>7381887c<IDType>cbc1ad16-3fd501cd-49b0424a-896c900c-06b692efbb59<45ccc8f630c3</IDWorkFlow>IDType>
      <Name>AdHoc<<TypeName>General</Name>TypeName>
      <Descr>A non scheduled collection.</Descr><Description>General</Description>
      <Colour>#f5c9cb</Colour>
   </JobTypeObj>
   <JobTypeObj>
      <IDJobType>023850a1-ac56-47f5-a90a-8ec48c346305</IDJobType>
      <IDWorkFlow>7381887c-3fd5-49b0-896c-06b692efbb59</IDWorkFlow>
      <Name>Drop Off</Name>
      <Descr>Scheduled and non scheduled delivery.</Descr>
      <Colour>#faf59b</Colour>
   </JobTypeObj>
   <JobTypeObj>
      <IDJobType>bd176be9-8c1b-4cd3-9b54-5ad51b2de3f4</IDJobType>
      <IDWorkFlow>7381887c-3fd5-49b0-896c-06b692efbb59</IDWorkFlow>
      <Name>Pickup</Name>
      <Descr>A scheduled collection.</Descr>
      <Colour>#99CCFF</Colour>
   </JobTypeObj>
</ArrayOfJobTypeObj>

...

Returns a list of all note types configured in Crittah.

...

</TypeCrittah>
</ArrayOfTypeCrittah>

Anchor
JobTypes
JobTypes
Job Types

Returns a list of all job types configured in Crittah.

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/types/job
GET	Returns data defining job types

Data fields

Field	Value type	Description	Example
IDJobType	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
IDWorkFlow	string	ID of the workflow used for the specific job type.	jdk0fad1-c4da-4488-ereb-55ee9847edcc
Name	string	Name of job	AdHoc
Descr	string	Description of job	AdHoc job used for last minute work
Colour	string	HEX colour used to colour code the job	#hhjkgf

Get job types

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

...

/types/

...

Data fields

Field	Value type	Description	Example
IDType	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
TypeName	string	Name of type	General
Description	string	description of type	General note type

Get note types

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/types/note

JSON Rsponse:

Code Block
[job

JSON Rsponse:

Code Block

[
  {
    "IDJobType": "49b86bf8-a610-4594-baea-30b76c21974d",
    "IDWorkFlow": "7381887c-3fd5-49b0-896c-06b692efbb59",
    "Name": "AdHoc",
    "Descr": "A non scheduled job.",
    "Colour": "#f5c9cb"
  },
  {
    "IDTypeIDJobType": "22fcd267023850a1-1958ac56-4a2747f5-8e9ca90a-09139ea3f8a88ec48c346305",
    "TypeNameIDWorkFlow": "Delivery7381887c-3fd5-49b0-896c-06b692efbb59",
    "DescriptionName": "DeliveryDrop DetailsOff",
  },
  {
    "IDType": "77d5d244-eb29-4b5b-8b14-87d92b4215ea",
    "TypeName": "General",
    "Description": "General Note"
  },
  {
    "IDType": "2b11efc3-2a43-4c03-92ac-923e77f821a2",
    "TypeName": "Important",
    "Description": "Important Note"
  }
]

XML Response:

Code Block

<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfTypeCrittah xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <TypeCrittah>
      <IDType>22fcd267-1958-4a27-8e9c-09139ea3f8a8</IDType>
      <TypeName>Delivery</TypeName>
      <Description>Delivery Details</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>77d5d244-eb29-4b5b-8b14-87d92b4215ea</IDType>
      <TypeName>General</TypeName>
      <Description>GeneralNote</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>2b11efc3-2a43-4c03-92ac-923e77f821a2</IDType>
      <TypeName>Important</TypeName>
      <Description>Important Note</Description>
   </TypeCrittah>
</ArrayOfTypeCrittah>  "Descr": "Scheduled and non scheduled delivery items to customer. ",
    "Colour": "#faf59b"
  },
  {
    "IDJobType": "bd176be9-8c1b-4cd3-9b54-5ad51b2de3f4",
    "IDWorkFlow": "7381887c-3fd5-49b0-896c-06b692efbb59",
    "Name": "Pickup",
    "Descr": "A scheduled collection. ",
    "Colour": "#99CCFF"
  }
]

XML Response:

Code Block

<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfJobTypeObj xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <JobTypeObj>
      <IDJobType>49b86bf8-a610-4594-baea-30b76c21974d</IDJobType>
      <IDWorkFlow>7381887c-3fd5-49b0-896c-06b692efbb59</IDWorkFlow>
      <Name>AdHoc</Name>
      <Descr>A non scheduled collection.</Descr>
      <Colour>#f5c9cb</Colour>
   </JobTypeObj>
   <JobTypeObj>
      <IDJobType>023850a1-ac56-47f5-a90a-8ec48c346305</IDJobType>
      <IDWorkFlow>7381887c-3fd5-49b0-896c-06b692efbb59</IDWorkFlow>
      <Name>Drop Off</Name>
      <Descr>Scheduled and non scheduled delivery.</Descr>
      <Colour>#faf59b</Colour>
   </JobTypeObj>
   <JobTypeObj>
      <IDJobType>bd176be9-8c1b-4cd3-9b54-5ad51b2de3f4</IDJobType>
      <IDWorkFlow>7381887c-3fd5-49b0-896c-06b692efbb59</IDWorkFlow>
      <Name>Pickup</Name>
      <Descr>A scheduled collection.</Descr>
      <Colour>#99CCFF</Colour>
   </JobTypeObj>
</ArrayOfJobTypeObj>

Anchor
NoteTypes
NoteTypes
Note Types

Returns a list of all note types configured in Crittah.

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/types/note
GET	Returns data defining contact types

Data fields

Field	Value type	Description	Example
IDType	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
TypeName	string	Name of type	General
Description	string	description of type	General note type

Get note types

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/types/note

JSON Rsponse:

Code Block

[
  {
    "IDType": "22fcd267-1958-4a27-8e9c-09139ea3f8a8",
    "TypeName": "Delivery",
    "Description": "Delivery Details"
  },
  {
    "IDType": "77d5d244-eb29-4b5b-8b14-87d92b4215ea",
    "TypeName": "General",
    "Description": "General Note"
  },
  {
    "IDType": "2b11efc3-2a43-4c03-92ac-923e77f821a2",
    "TypeName": "Important",
    "Description": "Important Note"
  }
]

XML Response:

Code Block

<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfTypeCrittah xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <TypeCrittah>
      <IDType>22fcd267-1958-4a27-8e9c-09139ea3f8a8</IDType>
      <TypeName>Delivery</TypeName>
      <Description>Delivery Details</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>77d5d244-eb29-4b5b-8b14-87d92b4215ea</IDType>
      <TypeName>General</TypeName>
      <Description>GeneralNote</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>2b11efc3-2a43-4c03-92ac-923e77f821a2</IDType>
      <TypeName>Important</TypeName>
      <Description>Important Note</Description>
   </TypeCrittah>
</ArrayOfTypeCrittah>

Anchor
ClosedReasons
ClosedReasons
Closed Reasons

Returns a list of all closed reasons configured in Crittah.

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/closedreasons
GET	Returns data defining contact types

Data fields

Field	Value type	Description	Example
IDType	string	Unique identifier of the closed reason	7090fad1-c4da-4488-9ceb-55ee9847edcc
TypeName	string	Name of closed reasons	VIP
Description	string	description of closed reason	Very important customer

Get closed reasons

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/closedreasons

JSON Rsponse:

Code Block

[
    {
        "IDType": "24501b6f-dbeb-4344-a565-419bd2df26fe",
        "TypeName": "No longer needed",
        "Description": "No longer needed"
    },
 {
        "IDType": "24501b6f-dbeb-4344-a565-419bd2df26fe",
        "TypeName": "customer cancelled",
        "Description": "customer cancelled"
    }
]

Anchor
ContactStatuses
ContactStatuses
Contact Status

...

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/statuses/contact
GET	Returns data defining contact status

Data fields

Field	Value type	Description	Example
IDStatus	string		Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
StatusName	string	Name of status	Active
Description	string		description of status	Acitve

...

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/statuses/customer
GET	Returns data defining customer status

Data fields

Field	Value type	Description	Example
IDStatus	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
StatusName	string	Name of status	Active
Description	string		description of status	Acitve

...

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/users
GET	Returns data of all users

Data fields

Field	Value type	Description	Example
IDUser	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
Salutation	string		Salutation of the user	Mr
FirstName	string	First name of the user	John
LastName	string		Last name of the user	Smith

...

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/statuses/jobtype/[IDJobType]
GET	Returns data defining job statuses

Data fields

Field	Value type	Description	Example
IDJobType	string		Unique ID for the job type. This is required to return the statuses for s specifc job typ	7090fad1-c4da-4488-9ceb-55ee9847edcc
IDStatus	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
StatusName	string		Salutation of the user	Mr
Description	string	First name of the user	John

...

Versions Compared

Old Version 6

New Version Current

Key

Anchor

LeadSourceTypes

LeadSourceTypes

Lead Sources

Get customer types

Anchor

CustomerTypes

CustomerTypes

Customer Types

Data fields

Get

customer types

Anchor

ContactTypes

ContactTypes

Contact Types

Data fields

Get contact types

Anchor
JobTypes
JobTypes
Job Types

Data fields

Get job types

Data fields

Get note types

Anchor
NoteTypes
NoteTypes
Note Types

Data fields

Get note types

Anchor
ClosedReasons
ClosedReasons
Closed Reasons

Data fields

Get closed reasons

Anchor
ContactStatuses
ContactStatuses
Contact Status

Data fields

Data fields

Data fields

Data fields

Page Comparison

Versions Compared

Old Version 6

New Version Current

Key

Anchor

LeadSourceTypes

LeadSourceTypes

Lead Sources

Get customer types

Anchor

CustomerTypes

CustomerTypes

Customer Types

Data fields

Get

customer types

Anchor

ContactTypes

ContactTypes

Contact Types

Data fields

Get contact types

AnchorJobTypesJobTypesJob Types

Data fields

Get job types

Data fields

Get note types

AnchorNoteTypesNoteTypesNote Types

Data fields

Get note types

AnchorClosedReasonsClosedReasonsClosed Reasons

Data fields

Get closed reasons

AnchorContactStatusesContactStatusesContact Status

Data fields

Data fields

Data fields

Data fields

Anchor
JobTypes
JobTypes
Job Types

Anchor
NoteTypes
NoteTypes
Note Types

Anchor
ClosedReasons
ClosedReasons
Closed Reasons

Anchor
ContactStatuses
ContactStatuses
Contact Status