API Documentation
Job API Object
Properties of the Job API object. Here you can find detailed information on each property, its data type, read/write permissions, and a brief description.
Job API Object
| Property | Type | R/W | Description |
|---|---|---|---|
| id | TEXT | R | Job unique ID |
| type | INT | RW | Job Type: 0=Work, 1=Pickup, 2=Dropoff |
| teamId | INT | RW | Team Id 0-n (the number of the team). Defaults to 0 (no specific team). |
| destinationName | TEXT | RW | Title of this job (1-line description) |
| destinationLat | DOUBLE | RW | Latitude |
| destinationLng | DOUBLE | RW | Longitude |
| destinationText | TEXT | RW | Location Address |
| destinationUrl | TEXT | RW | Location map URL |
| textDispatcher | TEXT | RW | Dispatcher additional info text (multi-line) |
| textReceiver | TEXT | RW | Worker’s reply text |
| contactName | TEXT | RW | Name of contact at job’s location |
| contactPhone | TEXT | RW | Phone number of contact at job’s location |
| contactEmail | TEXT | RW | Email of contact at job’s location |
| day | INT | RW | Date for job as YYYYMMDD or 0 (e.g. 20150530) |
| priority | INT | RW | Priority min:0-max:10 |
| number | INT | RW | Sequence number for ordering |
| onSiteSeconds | INT | RW | The assumed onsite-time in seconds (e.g. 10min on site: 600) |
| windowStart | INT | RW | Format: HHMM or 0 (e.g 704 = 7:04am) |
| windowEnd | INT | RW | Format: HHMM or 0 (e.g 1724 = 5:24pm) |
| orderId | INT | RW | Optional Order ID as an integer number |
| dispatcherUid | TEXT | RW | UID of dispatcher account |
| dispatcherName | TEXT | R | Name of Dispatcher |
| dispatcherUrl | TEXT | R | URL for dispatcher icon image |
| placeUid | TEXT | RW | UID of place to visit or “” |
| placeName | TEXT | R | Name of place/location |
| placeUrl | TEXT | R | URL for place icon image |
| radius | INT | R | Radius for check-in/out in meter (place-radius or default-radius) |
| worker | TEXT | RW | User name of assigned worker |
| workerName | TEXT | R | Full name of assigned worker |
| itemsToDropoff | INT | RW | Number of items to drop off |
| itemsToPickup | INT | RW | Number of items to pick up |
| status | TEXT | R | Set to archived if job is archived, omitted otherwise |
Job Status attributes (progress)
The job status attributes hold the timestamp when an event has occurred or 0 if it does not apply.
Note: Timestamps are milliseconds, between the current time and midnight, January 1, 1970 UTC (Java timestamps)
E.g.: 1430580377000 = Sat, 02 May 2015 15:26:17 GMT
| Property | Type | R/W | Description |
|---|---|---|---|
| tsCreated | LONG | RW | Timestamp in millis for job creation |
| tsAssigned | LONG | R | Timestamp in millis for job assigned to worker |
| tsAccepted | LONG | RW | Timestamp in millis for job accepted by worker |
| tsRejected | LONG | RW | Timestamp in millis for job rejected by worker |
| tsDoneSuccess | LONG | RW | Timestamp in millis for job marked as success by worker |
| tsDoneFailed | LONG | RW | Timestamp in millis for job marked as issue by worker |
| tsCheckIn | LONG | RW | Timestamp in millis for auto check-in by worker |
| tsCheckOut | LONG | RW | Timestamp in millis for auto check-out by worker |
| tsCheckNFC1 | LONG | RW | Timestamp in millis for first check with NFC |
| tsCheckNFC2 | LONG | RW | Timestamp in millis for second check with NFC |
Customizable Attributes:
| Property | Type | R/W | Description |
|---|---|---|---|
| custom_$ | TEXT | RW | Custom field where $ is the desired field name |
| extra_number_$_key | TEXT | R | Worker input number field where $ is 1-10 |
| extra_number_$_val | INT | RW | Worker input number value where $ is 1-10 |
| extra_text_$_key | TEXT | R | Worker input text field where $ is 1-20 |
| extra_text_$_val | TEXT | RW | Worker input text value where $ is 1-20 |