SitesReturns a list of all sites configured in Crittah.
Data fields
Field | Value type | Mandatory | 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 |
Get
...
Sites
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
|
...
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 SourcesReturns a list of all lead sources configured in Crittah.
Data fields
Field | Value type | Mandatory | Description | Example |
---|
IDType | string |
| Unique identifier of the type | 7090fad1-c4da-4488-9ceb-55ee9847edcc |
TypeName | string |
| Name of type | Phone |
Description | string |
| description of type | 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/leadsources
|
JSON Rsponse:
Code Block |
---|
[
{
"IDType": "4d819963-731c-41fd-9378-fd7a10199b78",
"TypeName": "Phone",
"Description": "Lead generated by phone"
},
{
"IDType": "81c3c93e-fed4-4491-81d2-b9c8e6de5fac",
"TypeName": "Web",
"Description": "Web Lead"
},
{
"IDType": "101f4545-d10c-4bd5-a8b5-325258968649",
"TypeName": "Referral",
"Description": "Referral from existing customer"
}
] |
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>Web</TypeName>
<Description>Web Lead</Description>
</TypeCrittah>
<TypeCrittah>
<IDType>101f4545-d10c-4bd5-a8b5-325258968649</IDType>
<TypeName>Referral</TypeName>
<Description>Referral from existing customer</Description>
</TypeCrittah>
</ArrayOfTypeCrittah> |
Anchor |
---|
| CustomerTypes |
---|
| CustomerTypes |
---|
|
Customer TypesReturns a list of all customer types configured in Crittah.
Data fields
Field | Value type | Mandatory | 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/customer
|
JSON Rsponse:
Code Block |
---|
[
{
"IDType": "4d819963-731c-41fd-9378-fd7a10199b78",
"TypeName": "Associates",
"Description": "Associates"
},
{
"IDType": "81c3c93e-fed4-4491-81d2-b9c8e6de5fac",
"TypeName": "Bulk delivery",
"Description": "Bulk delivery"
},
{
"IDType": "101f4545-d10c-4bd5-a8b5-325258968649",
"TypeName": "General",
"Description": "General 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>
<Description>Bulk delivery</Description>
</TypeCrittah>
<TypeCrittah>
<IDType>101f4545-d10c-4bd5-a8b5-325258968649</IDType>
<TypeName>General</TypeName>
<Description>General</Description>
</TypeCrittah>
<TypeCrittah>
<IDType>eac9f42e-8fd9-4b03-97fe-fd870c75aab1</IDType>
<TypeName>Receiver</TypeName>
<Description>Receiver</Description>
</TypeCrittah>
</ArrayOfTypeCrittah> |
Contact TypesReturns a list of all contact types configured in Crittah.
Data fields
Field | Value type | Mandatory | 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 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/contact
|
JSON Rsponse:
Code Block |
---|
[
{
"IDType": "7e56478b-70ab-4b8c-aa0d-c4729f98ccb2",
"TypeName": "Accounts",
"Description": "Accounts"
},
{
"IDType": "2e554838-1291-4605-8e64-dc97104a216e",
"TypeName": "CEO",
"Description": "CEO"
},
{
"IDType": "cbc1ad16-01cd-424a-900c-45ccc8f630c3",
"TypeName": "General",
"Description": "General"
}
] |
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-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>
<IDType>cbc1ad16-01cd-424a-900c-45ccc8f630c3</IDType>
<TypeName>General</TypeName>
<Description>General</Description>
</TypeCrittah>
</ArrayOfTypeCrittah> |
Job Types
Returns a list of all job types configured in Crittah.
Data fields
Field | Value type | Mandatory | 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/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"
},
{
"IDJobType": "023850a1-ac56-47f5-a90a-8ec48c346305",
"IDWorkFlow": "7381887c-3fd5-49b0-896c-06b692efbb59",
"Name": "Drop Off",
"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> |
Note TypesReturns a list of all note types configured in Crittah.
Data fields
Field | Value type | Mandatory | 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 ReasonsReturns a list of all closed reasons configured in Crittah.
Data fields
Field | Value type | Mandatory | 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 StatusReturns a list of all contact statuses configured in Crittah.
Data fields
Field | Value type | Mandatory | 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 |
Get contact status
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/statuses/contact
|
JSON Rsponse:
Code Block |
---|
[
{
"IDStatus": "926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa",
"StatusName": "Active",
"Description": "Active"
},
{
"IDStatus": "e9fafb7c-6830-4a97-b795-4601f5157134",
"StatusName": "General",
"Description": "General"
},
{
"IDStatus": "5ca214d1-4f29-462f-9e77-561ede9ee415",
"StatusName": "Inactive",
"Description": "Inactive"
}
] |
XML Response:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfStatus xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Status>
<IDStatus>926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa</IDStatus>
<StatusName>Active</StatusName>
<Description>Active</Description>
</Status>
<Status>
<IDStatus>e9fafb7c-6830-4a97-b795-4601f5157134</IDStatus>
<StatusName>General</StatusName>
<Description>General</Description>
</Status>
<Status>
<IDStatus>5ca214d1-4f29-462f-9e77-561ede9ee415</IDStatus>
<StatusName>Inactive</StatusName>
<Description>Inactive</Description>
</Status>
</ArrayOfStatus> |
Anchor |
---|
| CustomerStatuses |
---|
| CustomerStatuses |
---|
|
Customer StatusReturns a list of all customer statuses configured in Crittah.
Data fields
Field | Value type | Mandatory | 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 |
Get customer status
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/statuses/customer
|
JSON Rsponse:
Code Block |
---|
[
{
"IDStatus": "926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa",
"StatusName": "Active",
"Description": "Active"
}
{
"IDStatus": "e9fafb7c-6830-4a97-b795-4601f5157134",
"StatusName": "General",
"Description": "General"
},
{
"IDStatus": "5ca214d1-4f29-462f-9e77-561ede9ee415",
"StatusName": "Inactive",
"Description": "Inactive"
}
] |
XML Response:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfStatus xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Status>
<IDStatus>926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa</IDStatus>
<StatusName>Active</StatusName>
<Description>Active</Description>
</Status>
<Status>
<IDStatus>e9fafb7c-6830-4a97-b795-4601f5157134</IDStatus>
<StatusName>General</StatusName>
<Description>General</Description>
</Status>
<Status>
<IDStatus>5ca214d1-4f29-462f-9e77-561ede9ee415</IDStatus>
<StatusName>Inactive</StatusName>
<Description>Inactive</Description>
</Status>
</ArrayOfStatus> |
UsersReturns a list of all users configured in Crittah.
Data fields
Field | Value type | Mandatory | 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 |
Get users
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/users
|
JSON Rsponse:
Code Block |
---|
[
{
"IDUser": "3f4c7e0b-3e6b-4a3b-b998-0103e1b2b1b6",
"Salutation": "Mr",
"FirstName": "Peter",
"LastName": "Israelski"
},
{
"IDUser": "e5d2471f-a154-4423-9615-0177bcefe532",
"Salutation": "Mr",
"FirstName": "Aaron",
"LastName": "Davis"
}
] |
XML Response:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfStatus xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Status>
<IDStatus>926a4185-6cb3-4a2a-a8ec-1fadc1cf4caa</IDStatus>
<StatusName>Active</StatusName>
<Description>Active</Description>
</Status>
<Status>
<IDStatus>e9fafb7c-6830-4a97-b795-4601f5157134</IDStatus>
<StatusName>General</StatusName>
<Description>General</Description>
</Status>
<Status>
<IDStatus>5ca214d1-4f29-462f-9e77-561ede9ee415</IDStatus>
<StatusName>Inactive</StatusName>
<Description>Inactive</Description>
</Status>
</ArrayOfStatus> |
Job StatusesReturns a list of all job statuses configured in Crittah.
Data fields
Field | Value type | Mandatory | 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 |
Get job type statuses
To obtain the status for a given job type you need to specify the job type ID in the call. Each job type can have a specific workflow so the statuses for each job can differ.
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/statuses/jobtype/BD176BE9-8C1B-4CD3-9B54-5AD51B2DE3F4
|
JSON Rsponse:
Code Block |
---|
[
{
"IDStatus": "1aabdc9c-ba61-4aa4-93d1-11f21c47807b",
"StatusName": "In-Progress",
"Description": "Job has is in progress"
},
{
"IDStatus": "f24909a7-b645-4260-95d6-175753f9d643",
"StatusName": "Complete",
"Description": "Job Completed"
},
{
"IDStatus": "cbe9cc90-5465-46d8-9e10-34671a4c420f",
"StatusName": "Closed",
"Description": "Job Closed"
}
] |
XML Response:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfJobStatus xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<JobStatus>
<IDStatus>1aabdc9c-ba61-4aa4-93d1-11f21c47807b</IDStatus>
<StatusName>In-Progress</StatusName>
<Description>Job has is in progress</Description>
</JobStatus>
<JobStatus>
<IDStatus>f24909a7-b645-4260-95d6-175753f9d643</IDStatus>
<StatusName>Complete</StatusName>
<Description>Job Completed</Description>
</JobStatus>
<JobStatus>
<IDStatus>cbe9cc90-5465-46d8-9e10-34671a4c420f</IDStatus>
<StatusName>Closed</StatusName>
<Description>Job Closed</Description>
</JobStatus>
</ArrayOfJobStatus> |