Google Maps Coordinate API v1

Version: 5.3

Google Maps Coordinate API v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you view and manage jobs in a Coordinate team. Google documentation.

(require gapi/macro)

(require-gapi-doc "coordinate.v1.js")

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 customFieldDef

procedure
(coordinate-customFieldDef-list #:teamId teamId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  teamId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves a list of custom field definitions for a team.

teamId: Team ID

2.2 jobs

procedure
(coordinate-jobs-list
#:teamId teamId
[ #:minModifiedTimestampMs minModifiedTimestampMs
#:maxResults maxResults
#:pageToken pageToken
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  teamId : string?
  minModifiedTimestampMs : string? = 'N/A
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves jobs created or modified since the given timestamp.

teamId: Team ID

minModifiedTimestampMs: Minimum time a job was modified in milliseconds since epoch.

maxResults: Maximum number of results to return in one page.

pageToken: Continuation token

procedure
(coordinate-jobs-get #:teamId teamId
#:jobId jobId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  teamId : string?
  jobId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves a job, including all the changes made to the job.

teamId: Team ID

jobId: Job number

procedure
(coordinate-jobs-insert
#:address address
#:lat lat
#:lng lng
#:teamId teamId
#:title title
[ #:customField customField
#:assignee assignee
#:customerName customerName
#:customerPhoneNumber customerPhoneNumber
#:note note
#:id id
#:state state
#:jobChange jobChange
#:kind kind
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  address : string?
  lat : string?
  lng : string?
  teamId : string?
  title : string?
  customField : string? = 'N/A
  assignee : string? = 'N/A
  customerName : string? = 'N/A
  customerPhoneNumber : string? = 'N/A
  note : string? = 'N/A
  id : string? = 'N/A
  state : string? = 'N/A
  jobChange : string? = 'N/A
  kind : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Inserts a new job. Only the state field of the job should be set.

address: Job address as newline (Unix) separated string

lat: The latitude coordinate of this job’s location.

lng: The longitude coordinate of this job’s location.

teamId: Team ID

title: Job title

customField: Map from custom field id (from /team//custom_fields) to the field value. For example ’123=Alice’

assignee: Assignee email address, or empty string to unassign.

customerName: Customer name

customerPhoneNumber: Customer phone number

note: Job note as newline (Unix) separated string

id: Job id.

state: Current job state.

jobChange: List of job changes since it was created. The first change corresponds to the state of the job when it was created.

kind: Identifies this object as a job.

procedure
(coordinate-jobs-patch
#:teamId teamId
#:jobId jobId
[ #:address address
#:progress progress
#:customField customField
#:assignee assignee
#:customerName customerName
#:customerPhoneNumber customerPhoneNumber
#:note note
#:lat lat
#:lng lng
#:title title
#:id id
#:state state
#:jobChange jobChange
#:kind kind
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  teamId : string?
  jobId : string?
  address : string? = 'N/A
  progress : string? = 'N/A
  customField : string? = 'N/A
  assignee : string? = 'N/A
  customerName : string? = 'N/A
  customerPhoneNumber : string? = 'N/A
  note : string? = 'N/A
  lat : string? = 'N/A
  lng : string? = 'N/A
  title : string? = 'N/A
  id : string? = 'N/A
  state : string? = 'N/A
  jobChange : string? = 'N/A
  kind : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.

teamId: Team ID

jobId: Job number

address: Job address as newline (Unix) separated string

progress: Job progress

customField: Map from custom field id (from /team//custom_fields) to the field value. For example ’123=Alice’

assignee: Assignee email address, or empty string to unassign.

customerName: Customer name

customerPhoneNumber: Customer phone number

note: Job note as newline (Unix) separated string

lat: The latitude coordinate of this job’s location.

lng: The longitude coordinate of this job’s location.

title: Job title

id: Job id.

state: Current job state.

jobChange: List of job changes since it was created. The first change corresponds to the state of the job when it was created.

kind: Identifies this object as a job.

procedure
(coordinate-jobs-update
#:teamId teamId
#:jobId jobId
[ #:address address
#:progress progress
#:customField customField
#:assignee assignee
#:customerName customerName
#:customerPhoneNumber customerPhoneNumber
#:note note
#:lat lat
#:lng lng
#:title title
#:id id
#:state state
#:jobChange jobChange
#:kind kind
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  teamId : string?
  jobId : string?
  address : string? = 'N/A
  progress : string? = 'N/A
  customField : string? = 'N/A
  assignee : string? = 'N/A
  customerName : string? = 'N/A
  customerPhoneNumber : string? = 'N/A
  note : string? = 'N/A
  lat : string? = 'N/A
  lng : string? = 'N/A
  title : string? = 'N/A
  id : string? = 'N/A
  state : string? = 'N/A
  jobChange : string? = 'N/A
  kind : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Updates a job. Fields that are set in the job state will be updated.

teamId: Team ID

jobId: Job number

address: Job address as newline (Unix) separated string

progress: Job progress

customField: Map from custom field id (from /team//custom_fields) to the field value. For example ’123=Alice’

assignee: Assignee email address, or empty string to unassign.

customerName: Customer name

customerPhoneNumber: Customer phone number

note: Job note as newline (Unix) separated string

lat: The latitude coordinate of this job’s location.

lng: The longitude coordinate of this job’s location.

title: Job title

id: Job id.

state: Current job state.

jobChange: List of job changes since it was created. The first change corresponds to the state of the job when it was created.

kind: Identifies this object as a job.