...
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 |
...
Customer Types
Returns a list of all sites customer types configured in Crittah.
Method | Result |
---|---|
URI | https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/types/customer |
GET | Returns data defining customer types |
...
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 |
...
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 Types
Returns a list of all sites contact types configured in Crittah.
Method | Result |
---|---|
URI | https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/types/contact |
GET | Returns data defining contact types |
...
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 |
...
Job Types
Returns a list of all sites 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 |
...
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 |
...
Note Types
Returns a list of all sites 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 |
...
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 |
...
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> |
Contact Status
Customer Status
Users
Returns a list of all contact statuses configured in Crittah.
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 | 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> |
Customer Status
Returns a list of all customer statuses configured in Crittah.
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 | 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> |
Users
Returns a list of all users configured in Crittah.
Method | Result |
---|---|
URI | https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/users |
GET | Returns data defining customer status |
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 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/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> |