Copyright	(c) 2015 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Coordinate.Jobs.Patch

Contents

REST Resource
Creating a Request
Request Lenses

Description

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

See: Google Maps Coordinate API Reference for coordinate.jobs.patch.

Synopsis

REST Resource

type JobsPatchResource = "coordinate" :> ("v1" :> ("teams" :> (Capture "teamId" Text :> ("jobs" :> (Capture "jobId" (Textual Word64) :> (QueryParam "progress" JobsPatchProgress :> (QueryParam "note" Text :> (QueryParam "customerPhoneNumber" Text :> (QueryParam "customerName" Text :> (QueryParam "address" Text :> (QueryParam "assignee" Text :> (QueryParam "lat" (Textual Double) :> (QueryParam "lng" (Textual Double) :> (QueryParam "title" Text :> (QueryParams "customField" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` Job :> Patch `[JSON]` Job))))))))))))))))) Source

A resource alias for coordinate.jobs.patch method which the JobsPatch request conforms to.

Creating a Request

jobsPatch Source

Arguments

:: Word64	`jpJobId`
-> Text	`jpTeamId`
-> Job	`jpPayload`
-> JobsPatch

Creates a value of JobsPatch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data JobsPatch Source

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

See: jobsPatch smart constructor.

Instances

Eq JobsPatch Source
Data JobsPatch Source
Show JobsPatch Source
Generic JobsPatch Source
GoogleRequest JobsPatch Source
type Rep JobsPatch Source
type Rs JobsPatch = Job Source

Request Lenses

jpJobId :: Lens' JobsPatch Word64 Source

Job number

jpProgress :: Lens' JobsPatch (Maybe JobsPatchProgress) Source

Job progress

jpNote :: Lens' JobsPatch (Maybe Text) Source

Job note as newline (Unix) separated string

jpTeamId :: Lens' JobsPatch Text Source

Team ID

jpCustomerPhoneNumber :: Lens' JobsPatch (Maybe Text) Source

Customer phone number

jpCustomerName :: Lens' JobsPatch (Maybe Text) Source

Customer name

jpAddress :: Lens' JobsPatch (Maybe Text) Source

Job address as newline (Unix) separated string

jpPayload :: Lens' JobsPatch Job Source

Multipart request metadata.

jpAssignee :: Lens' JobsPatch (Maybe Text) Source

Assignee email address, or empty string to unassign.

jpLat :: Lens' JobsPatch (Maybe Double) Source

The latitude coordinate of this job's location.

jpLng :: Lens' JobsPatch (Maybe Double) Source

The longitude coordinate of this job's location.

jpTitle :: Lens' JobsPatch (Maybe Text) Source

Job title

jpCustomField :: Lens' JobsPatch [Text] Source

Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.