Click here to see your recently viewed pages and most viewed pages.
Hide
Google Maps Coordinate API
Notice
The Google Maps Coordinate API is deprecated. The API will continue to work until January 20, 2016. After that date, the API will no longer be available.

Jobs

A job resource contains information about a job: its location, assignee, progress, etc. It also contains all of the historical information about a job, as each job change is listed in the jobChange set.

For a list of methods for this resource, see the end of this page.

Resource representations

A job resource contains all information about a job, including both its current state and any changes that have been made to the job.

{
  "kind": "coordinate#job",
  "id": unsigned long,
  "state": {
    "kind": "coordinate#jobState",
    "assignee": string,
    "progress": string,
    "location": {
      "kind": "coordinate#location",
      "lat": double,
      "lng": double,
      "addressLine": [
        string
      ]
    },
    "note": [
      string
    ],
    "title": string,
    "customerName": string,
    "customerPhoneNumber": string,
    "customFields": {
      "kind": "coordinate#customFields",
      "customField": [
        {
          "kind": "coordinate#customField",
          "customFieldId": long,
          "value": string
        }
      ]
    }
  },
  "jobChange": [
    {
      "kind": "coordinate#jobChange",
      "timestamp": unsigned long,
      "state": {
        "kind": "coordinate#jobState",
        "assignee": string,
        "progress": string,
        "location": {
          "kind": "coordinate#location",
          "lat": double,
          "lng": double,
          "addressLine": [
            string
          ]
        },
        "note": [
          string
        ],
        "title": string,
        "customerName": string,
        "customerPhoneNumber": string,
        "customFields": {
          "kind": "coordinate#customFields",
          "customField": [
            {
              "kind": "coordinate#customField",
              "customFieldId": long,
              "value": string
            }
          ]
        }
      }
    }
  ]
}
Property name Value Description Notes
id unsigned long The unique job ID, as assigned by the API.
jobChange[] list List of job changes since it was created. The first change corresponds to the state of the job when it was created.
jobChange[].kind string Identifies this item as a job change. Job change items are always of kind coordinate#jobChange.
jobChange[].state nested object Change applied to the job. Only the fields that were changed are set.
jobChange[].state.assignee string Email address of the assignee, or the string "DELETED_USER" if the account is no longer available. writable
jobChange[].state.customFields nested object Custom fields. writable
jobChange[].state.customFields.customField[] list Collection of custom fields.
jobChange[].state.customFields.customField[].customFieldId long Custom field id.
jobChange[].state.customFields.customField[].kind string Identifies this object as a custom field.
jobChange[].state.customFields.customField[].value string Custom field value.
jobChange[].state.customFields.kind string Identifies this object as a collection of custom fields.
jobChange[].state.customerName string Customer name. writable
jobChange[].state.customerPhoneNumber string The customer's phone number. writable
jobChange[].state.kind string Identifies this object as a job state. Job state items are always of kind coordinate#jobState.
jobChange[].state.location nested object The job location object. writable
jobChange[].state.location.addressLine[] list The human-readable street address of the job's location.
jobChange[].state.location.kind string Identifies this object as a location item; locations are always of kind coordinate#location.
jobChange[].state.location.lat double The latitude coordinate of this job's location.
jobChange[].state.location.lng double The longitude coordinate of this job's location.
jobChange[].state.note[] list Note added to the job. writable
jobChange[].state.progress string Job progress. Possible values are NOT_ACCEPTED, NOT_STARTED, IN_PROGRESS, COMPLETED, or OBSOLETE.

Acceptable values are:
  • "COMPLETED"
  • "IN_PROGRESS"
  • "NOT_ACCEPTED"
  • "NOT_STARTED"
  • "OBSOLETE"
writable
jobChange[].state.title string Job title. writable
jobChange[].timestamp unsigned long Time at which this change was applied, in milliseconds since the Unix epoch.
kind string The kind of item this is. For jobs, this is always coordinate#job.
state nested object The current state of the job.
state.assignee string Email address of the assignee, or the string "DELETED_USER" if the account is no longer available. writable
state.customFields nested object Custom fields. writable
state.customFields.customField[] list Collection of custom fields.
state.customFields.customField[].customFieldId long Custom field id.
state.customFields.customField[].kind string Identifies this object as a custom field.
state.customFields.customField[].value string Custom field value.
state.customFields.kind string Identifies this object as a collection of custom fields.
state.customerName string The customer's name. writable
state.customerPhoneNumber string Customer phone number. No formatting or sanitizing takes place on this string. writable
state.kind string Identifies this as a coordinate#jobState item.
state.location nested object The job location object. writable
state.location.addressLine[] list The human-readable street address of the job's location.
state.location.kind string Identifies this object as a location item; locations are always of kind coordinate#location.
state.location.lat double The latitude coordinate of this job's location.
state.location.lng double The longitude coordinate of this job's location.
state.note[] list Note added to the job. writable
state.progress string Job progress. Possible values are NOT_ACCEPTED, NOT_STARTED, IN_PROGRESS, COMPLETED, or OBSOLETE.

Acceptable values are:
  • "COMPLETED"
  • "IN_PROGRESS"
  • "NOT_ACCEPTED"
  • "NOT_STARTED"
  • "OBSOLETE"
writable
state.title string The job's title. writable

Methods

get
Retrieves a job, including all the changes made to the job.
insert
Inserts a new job.
list
Retrieves jobs created or modified since the given timestamp.
update
Updates a job. Only the fields that are sent in the request are updated.