SOAP POI Web Service Reference

Table of Contents
Introduction .......................................................................................................................................... 7
Who should read this? ..................................................................................................................... 7
What can I do with this? .................................................................................................................. 7
SOAP 1.1 Protocol specifications ................................................................................................... 7
GpsGate Server SOAP Dispatch Web Service API 1.1........................................................................ 8
Entities description .......................................................................................................................... 8
AssignableWorker....................................................................................................................... 8
Job............................................................................................................................................... 8
Route........................................................................................................................................... 8
RouteJob ..................................................................................................................................... 8
Location ...................................................................................................................................... 8
JobState....................................................................................................................................... 8
Worker ........................................................................................................................................ 8
Dispatch Web Service .......................................................................................................................... 9
Description.................................................................................................................................. 9
Web Methods ................................................................................................................................... 9
CreateJob ......................................................................................................................................... 9
Description.................................................................................................................................. 9
Parameters .................................................................................................................................. 9
Request format ............................................................................................................................ 9
HTTP Headers........................................................................................................................ 9
HTTP XML Content .............................................................................................................. 9
Typical Request .................................................................................................................... 10
Typical Response ................................................................................................................. 10
DeleteJob ....................................................................................................................................... 10
Description................................................................................................................................ 10
Parameters ................................................................................................................................ 10
Request format .......................................................................................................................... 10
HTTP Headers...................................................................................................................... 10
HTTP XML Content ............................................................................................................ 11
Typical Request .................................................................................................................... 11
GetAssignableWorkers .................................................................................................................. 11
Description................................................................................................................................ 11
Parameters ................................................................................................................................ 11
Request format .......................................................................................................................... 12
HTTP Headers...................................................................................................................... 12
HTTP XML Content ............................................................................................................ 12
Typical Request .................................................................................................................... 12
DispatchJob ................................................................................................................................... 13
Description................................................................................................................................ 13
Parameters ................................................................................................................................ 13
Request format .......................................................................................................................... 13
HTTP Headers...................................................................................................................... 13
HTTP XML Content ............................................................................................................ 13
Typical Request .................................................................................................................... 14
ActivateJob .................................................................................................................................... 14
Description................................................................................................................................ 14
Parameters ................................................................................................................................ 14
Request format .......................................................................................................................... 14
HTTP Headers...................................................................................................................... 14
HTTP XML Content ............................................................................................................ 14
Typical Request .................................................................................................................... 15
CompleteJob .................................................................................................................................. 15
Description................................................................................................................................ 15
Parameters ................................................................................................................................ 15
Request format .......................................................................................................................... 15
HTTP Headers...................................................................................................................... 15
HTTP XML Content ............................................................................................................ 16
Typical Request .................................................................................................................... 16
GetJobs .......................................................................................................................................... 16
Description................................................................................................................................ 16
Parameters ................................................................................................................................ 16
Request format .......................................................................................................................... 17
HTTP Headers...................................................................................................................... 17
HTTP XML Content ............................................................................................................ 17
Typical Request .................................................................................................................... 17
GetAllChanges .............................................................................................................................. 19
Description................................................................................................................................ 19
Parameters ................................................................................................................................ 19
Request format .......................................................................................................................... 19
HTTP Headers...................................................................................................................... 19
HTTP XML Content ............................................................................................................ 19
Typical Request .................................................................................................................... 19
GetChangesSince .......................................................................................................................... 20
Description................................................................................................................................ 20
Parameters ................................................................................................................................ 20
Request format .......................................................................................................................... 21
HTTP Headers...................................................................................................................... 21
HTTP XML Content ............................................................................................................ 21
Typical Request .................................................................................................................... 21
GetChangesForUsers ..................................................................................................................... 22
Description................................................................................................................................ 22
Parameters ................................................................................................................................ 22
Request format .......................................................................................................................... 22
HTTP Headers...................................................................................................................... 22
HTTP XML Content ............................................................................................................ 22
Typical Request .................................................................................................................... 23
GetChangesForUsersSince ............................................................................................................ 24
Description................................................................................................................................ 24
Parameters ................................................................................................................................ 24
Request format .......................................................................................................................... 24
HTTP Headers...................................................................................................................... 24
HTTP XML Content ............................................................................................................ 24
Typical Request .................................................................................................................... 25
SetComment .................................................................................................................................. 26
Description................................................................................................................................ 26
Parameters ................................................................................................................................ 26
Request format .......................................................................................................................... 26
HTTP Headers...................................................................................................................... 26
HTTP XML Content ............................................................................................................ 26
Typical Request .................................................................................................................... 26
CreateRoute ................................................................................................................................... 28
Description................................................................................................................................ 28
Parameters ................................................................................................................................ 28
Request format .......................................................................................................................... 28
HTTP Headers...................................................................................................................... 28
HTTP XML Content ............................................................................................................ 28
Typical Request .................................................................................................................... 29
DeleteRoute ................................................................................................................................... 30
Description................................................................................................................................ 30
Parameters ................................................................................................................................ 30
Request format .......................................................................................................................... 30
HTTP Headers...................................................................................................................... 30
HTTP XML Content ............................................................................................................ 30
Typical Request .................................................................................................................... 30
DispatchRoute ............................................................................................................................... 31
Description................................................................................................................................ 31
Parameters ................................................................................................................................ 31
Request format .......................................................................................................................... 31
HTTP Headers...................................................................................................................... 31
HTTP XML Content ............................................................................................................ 31
Typical Request .................................................................................................................... 31
GetRoute........................................................................................................................................ 32
Description................................................................................................................................ 32
Parameters ................................................................................................................................ 32
Request format .......................................................................................................................... 32
HTTP Headers...................................................................................................................... 32
HTTP XML Content ............................................................................................................ 32
Typical Request .................................................................................................................... 33
CreateOptimalRoute ...................................................................................................................... 33
Description................................................................................................................................ 33
Parameters ................................................................................................................................ 33
Request format .......................................................................................................................... 34
HTTP Headers...................................................................................................................... 34
HTTP XML Content ............................................................................................................ 34
Typical Request .................................................................................................................... 34
OptimiseRoute ............................................................................................................................... 35
Description................................................................................................................................ 35
Parameters ................................................................................................................................ 35
Request format .......................................................................................................................... 35
HTTP Headers...................................................................................................................... 35
HTTP XML Content ............................................................................................................ 36
Typical Request .................................................................................................................... 36
GetRouteSchedule ......................................................................................................................... 37
Description................................................................................................................................ 37
Parameters ................................................................................................................................ 37
Request format .......................................................................................................................... 37
HTTP Headers...................................................................................................................... 37
HTTP XML Content ............................................................................................................ 37
Typical Request .................................................................................................................... 37
SetRouteSchedule.......................................................................................................................... 38
Description................................................................................................................................ 38
Parameters ................................................................................................................................ 38
Request format .......................................................................................................................... 38
HTTP Headers...................................................................................................................... 38
HTTP XML Content ............................................................................................................ 38
Typical Request .................................................................................................................... 39
DelayedRouteDispatching ............................................................................................................. 39
Description................................................................................................................................ 39
Parameters ................................................................................................................................ 40
Request format .......................................................................................................................... 40
HTTP Headers...................................................................................................................... 40
HTTP XML Content ............................................................................................................ 40
Typical Request .................................................................................................................... 40
AssignJob ...................................................................................................................................... 41
Description................................................................................................................................ 41
Parameters ................................................................................................................................ 41
Request format .......................................................................................................................... 41
HTTP Headers...................................................................................................................... 41
HTTP XML Content ............................................................................................................ 41
Typical Request .................................................................................................................... 42
AssignRoute .................................................................................................................................. 42
Description................................................................................................................................ 42
Parameters ................................................................................................................................ 42
Request format .......................................................................................................................... 43
HTTP Headers...................................................................................................................... 43
HTTP XML Content ............................................................................................................ 43
Typical Request .................................................................................................................... 43
MoveJob ........................................................................................................................................ 43
Description................................................................................................................................ 43
Parameters ................................................................................................................................ 44
Request format .......................................................................................................................... 44
HTTP Headers...................................................................................................................... 44
HTTP XML Content ............................................................................................................ 44
Typical Request .................................................................................................................... 44
GetJobInRange .............................................................................................................................. 45
Description................................................................................................................................ 45
Parameters ................................................................................................................................ 45
Request format .......................................................................................................................... 45
HTTP Headers...................................................................................................................... 45
HTTP XML Content ............................................................................................................ 45
Typical Request .................................................................................................................... 45
UnassignJob .................................................................................................................................. 47
Description................................................................................................................................ 47
Parameters ................................................................................................................................ 47
Request format .......................................................................................................................... 47
HTTP Headers...................................................................................................................... 47
HTTP XML Content ............................................................................................................ 47
Typical Request .................................................................................................................... 47
UnassignRoute .............................................................................................................................. 48
Description................................................................................................................................ 48
Parameters ................................................................................................................................ 48
Request format .......................................................................................................................... 48
HTTP Headers...................................................................................................................... 48
HTTP XML Content ............................................................................................................ 48
Typical Request .................................................................................................................... 48
PauseJob ........................................................................................................................................ 49
Description................................................................................................................................ 49
Parameters ................................................................................................................................ 49
Request format .......................................................................................................................... 49
HTTP Headers...................................................................................................................... 49
HTTP XML Content ............................................................................................................ 49
Typical Request .................................................................................................................... 49
GetJobCustomFields ..................................................................................................................... 50
Description................................................................................................................................ 50
Parameters ................................................................................................................................ 50
Request format .......................................................................................................................... 50
HTTP Headers...................................................................................................................... 50
HTTP XML Content ............................................................................................................ 50
Typical Request .................................................................................................................... 50
UpdateJobCustomField ................................................................................................................. 52
Description................................................................................................................................ 52
Parameters ................................................................................................................................ 52
Request format .......................................................................................................................... 52
HTTP Headers...................................................................................................................... 52
HTTP XML Content ............................................................................................................ 52
Typical Request .................................................................................................................... 52
GetRouteCustomFields ................................................................................................................. 53
Description................................................................................................................................ 53
Parameters ................................................................................................................................ 53
Request format .......................................................................................................................... 53
HTTP Headers...................................................................................................................... 53
HTTP XML Content ............................................................................................................ 53
Typical Request .................................................................................................................... 53
UpdateRouteCustomField ............................................................................................................. 54
Description................................................................................................................................ 54
Parameters ................................................................................................................................ 54
Request format .......................................................................................................................... 55
HTTP Headers...................................................................................................................... 55
HTTP XML Content ............................................................................................................ 55
Typical Request .................................................................................................................... 55
GetWorkerId .................................................................................................................................. 56
Description................................................................................................................................ 56
Parameters ................................................................................................................................ 56
Request format .......................................................................................................................... 56
HTTP Headers...................................................................................................................... 56
HTTP XML Content ............................................................................................................ 56
Typical Request .................................................................................................................... 56
Error handling .................................................................................................................................... 57
Typical Error Response ........................................................................................................ 57
Version History .................................................................................................................................. 58
Version 1.0 ................................................................................................................................ 58
Version 1.1 ................................................................................................................................ 58
Introduction
This document covers the specification of the GpsGate Server SOAP Dispatch Web Service API.
Who should read this?

Developers aiming to build applications which need to create and dispatch jobs to GpsGate Server.
What can I do with this?

Create dispatch jobs in GpsGate Server applications, find information on workers that are eligible to complete these jobs
and dispatch the jobs to those workers. Track status changes in ongoing jobs, complete and delete jobs or recover
historical job information for display in external applications.
SOAP 1.1 Protocol specifications

This API is fully based on SOAP protocol.
See: http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
GpsGate Server SOAP Dispatch Web Service API 1.1
This section describes the web methods and entities of the GpsGate Server SOAP Dispatch Web Service API 1.1.
Entities description
Here are the different business entities returned by the Dispatch service briefly described.
AssignableWorker
An Assignable Worker is an object which contains a numeric GpsGate User ID and some information about the suitability
of the specified user for a given job.
Job
A Job is the core entity created and updated by the GpsGate Server SOAP Dispatch Web Service API. It represents a
job in GpsGate Server and will be returned by the various methods that are used to find existing jobs and check for
updates.
Route
A Route is an entity that is created to hold and organise collections of related Jobs. A Route can be assigned to a worker
and dispatched in the same way as a standalone Job. When a Route is dispatched or deleted, all of it's contained Jobs
are dispatched or deleted along with the Route.
RouteJob
A RouteJob is an entity created to represent a Job that is contained within a Route. RouteJobs are more simple and
contain less properties than a standalone Job as they are intended to exist only within the context of their parent Route.
RouteJobs cannot be manipulated by the web service calls that are intended for standalone Jobs with the exception of
CompleteJob.
Location
A Location represents a position with address information.
JobState
A Job State indicates the state that a given job is in. The possible states are: Unassigned, Assigned, AssignedPending,
Active, ActivePending, Completed, CompletedPending, Deleted, DeletedPending and Planned.
Worker
A worker represents a user which has been assigned to a Job. This Worker entity contains more information than a
normal user about it's progress toward completing the Job it has been assigned to.
Dispatch Web Service
Description
This web service contains methods to create, dispatch and monitor dispatched jobs in GpsGate Server.
URL: http://localhost/GpsGateServer/Services/Dispatch.asmx
Note: All methods in this web service require the consumer to provide an encryped session ID. Obtain one of these for
your session by using the Login method of the GpsGate Server SOAP Directory Web Service.
Web Methods
CreateJob
Description
Create a new Dispatch Job by providing a job location, description and scheduled time.
Parameters
Name Type Example Description Required
strSessionID string 3085633935CCEA8D ID of the session from Yes
57A1A6DFA5386EC4 Login response. Used
to authenticate and
authorize the request.
iApplicationID int 4 ID of application being Yes
used for dispatch
dblLatitude double 2 Latitude of the job Yes
location
dblLongitude double 2 Longitude of the job Yes
location
strDescription string Deliver pizza Description of the job Yes
dtDate dateTime 2007-10- Date and time of the No
09T12:00:00Z job
Request format
HTTP Headers
POST /ggs/services/Dispatch.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://gpsgate.com/services/CreateJob"
HTTP XML Content

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateJob xmlns="http://gpsgate.com/services/">
<strSessionID>string</strSessionID>
<iApplicationID>int</iApplicationID>
<dblLatitude>double</dblLatitude>
<dblLongitude>double</dblLongitude>
<strDescription>string</strDescription>
<dtDate>dateTime</dtDate>
</CreateJob>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<CreateJob xmlns="http://gpsgate.com/services/">
<strSessionID>3085633935CCEA8D57A1A6DFA5386EC4</strSessionID>
<iApplicationID>4</iApplicationID>
<dblLatitude>12</dblLatitude>
<dblLongitude>12</dblLongitude>
<strDescription>Deliver pizza</strDescription>
<dtDate>2007-10-09T12:00:00Z</dtDate>
</CreateJob>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<CreateJobResponse xmlns="http://gpsgate.com/services/">
<CreateJobResult>1</CreateJobResult>
</CreateJobResponse>
</soap:Body>
</soap:Envelope>
DeleteJob
Description
Delete an existing Dispatch Job by providing it's Job ID.
Parameters
to authenticate and
used for dispatch
iJobId int 1 ID of the job to be Yes
deleted
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/DeleteJob"
HTTP XML Content

<soap:Body>
<DeleteJob xmlns="http://gpsgate.com/services/">
<iJobId>int</iJobId>
</DeleteJob>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<DeleteJob xmlns="http://gpsgate.com/services/">
<iJobId>1</iJobId>
</DeleteJob>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<DeleteJobResponse xmlns="http://gpsgate.com/services/" />
</soap:Body>
</soap:Envelope>
GetAssignableWorkers
Description
Get details on all workers that are eligible to be dispatched to a Job. Supplying a job ID will return an array of Assignable
Workers containing information on eligible workers' suitability for the job.
Parameters
strSessionID string 3085633935CCEA8D57A1A6DFA ID of the session from Yes
5386EC4 Login response. Used to
authenticate and authorize
the request.
iApplicationID int 4 ID of application being used Yes
for dispatch
iJobId int 1 ID of the job for which to Yes
find Assignable Workers
iMaxResults int 1 The maximum number of Yes
workers to return in the
results. Limit this property
for better performance
Request format
HTTP Headers
POST /ggs/services/Gpsgate.Dispatch.Service/API/Dispatch.asmx HTTP/1.1
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetAssignableWorkers"
HTTP XML Content

<soap:Body>
<GetAssignableWorkers xmlns="http://gpsgate.com/services/">
<iMaxResults>int</iMaxResults>
</GetAssignableWorkers>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<GetAssignableWorkers xmlns="http://gpsgate.com/services/">
<iJobId>1</iJobId>
<iMaxResults>5</iMaxResults>
</GetAssignableWorkers>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<GetAssignableWorkersResponse xmlns="http://gpsgate.com/services/">
<GetAssignableWorkersResult>
<AssignableWorker>
<UserId>7</UserId>
<DistanceToJob>123</DistanceToJob>
<HasActiveJob>false</HasActiveJob>
<Name>Bob</Name>
<Username>bob</Username>
<UncompletedJobCount>0</UncompletedJobCount>
<isCurrentlyOnline>false</isCurrentlyOnline>
</AssignableWorker>
<AssignableWorker>
<UserId>9</UserId>
<DistanceToJob>12</DistanceToJob>
<HasActiveJob>true</HasActiveJob>
<Name>Bobette</Name>
<Username>bobette</Username>
<UncompletedJobCount>3</UncompletedJobCount>
<isCurrentlyOnline>true</isCurrentlyOnline>
</AssignableWorker>
</GetAssignableWorkersResult>
</GetAssignableWorkersResponse>
</soap:Body>
</soap:Envelope>
DispatchJob
Description
Dispatch a job to a worker by providing a Job ID and a Worker ID.
Parameters
strSessionID string 3085633935CCEA8D5 ID of the session from Yes
to authenticate and
used for dispatch
dispatched
iWorkerId int 1 ID of the worker to Yes
dispatch the job to
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/DispatchJob"
HTTP XML Content

<soap:Body>
<DispatchJob xmlns="http://gpsgate.com/services/">
<iWorkerId>int</iWorkerId>
</DispatchJob>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<DispatchJob xmlns="http://gpsgate.com/services/">
<iJobId>1</iJobId>
<iWorkerId>1</iWorkerId>
</DispatchJob>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<DispatchJobResponse xmlns="http://gpsgate.com/services/" />
</soap:Body>
</soap:Envelope>
ActivateJob
Description
Set an existing job to the Active state.
Parameters
the request.
for dispatch
iJobId int 1 ID of the job to be activated Yes
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/ActivateJob"
HTTP XML Content
<soap:Body>
<ActivateJob xmlns="http://gpsgate.com/services/">
</ActivateJob>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<ActivateJob xmlns="http://gpsgate.com/services/">
<iJobId>1</iJobId>
</ActivateJob>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<ActivateJobResponse xmlns="http://gpsgate.com/services/" />
</soap:Body>
</soap:Envelope>
CompleteJob
Description
Set an existing job to the Completed state.
Parameters
the request.
for dispatch
completed
Comment String This is a comment Any comment you want to No
attach to the job when you
complete it
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/CompleteJob"
HTTP XML Content

<soap:Body>
<CompleteJob xmlns="http://gpsgate.com/services/">
<comment>string</comment>
</CompleteJob>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<CompleteJob xmlns="http://gpsgate.com/services/">
<iJobId>1</iJobId>
<comment>super comment</comment>
</CompleteJob>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<CompleteJobResponse xmlns="http://gpsgate.com/services/" />
</soap:Body>
</soap:Envelope>
GetJobs
Description
Get all jobs that exist in the specified application.
Note: Do not use this operation as part of your application's general workflow. As more jobs are added to the server it will
become extremely expensive to make this call. A much better alternative is GetAllChanges.
Parameters
7A1A6DFA5386EC4 Login response. Used to
the request.
iApplicationID int 4 ID of application. Yes
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetJobs"
HTTP XML Content

<soap:Body>
<GetJobs xmlns="http://gpsgate.com/services/">
</GetJobs>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<GetJobs xmlns="http://gpsgate.com/services/">
</GetJobs>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<GetJobsResponse xmlns="http://gpsgate.com/services/">
<GetJobsResult>
<Job>
<ID>1</ID>
<Description>Deliver pizza</Description>
<Comment/>
<ActiveWorkersAllowed>1</ActiveWorkersAllowed>
<StartLocation>
<Location>
<Position>
<Lat>135.6301</Lat>
<Lon>112.50195</Lon>
<Alt>0</Alt>
</Position>
<CountryName>Sweden</CountryName>
<AdministrativeAreaName>Dalarnas län</AdministrativeAreaName>
<SubAdministrativeAreaName/>
<CityName/>
<PostalCodeNumber>65671</PostalCodeNumber>
<StreetName>341</StreetName>
<StreetBox/>
<Address>341, 65671 Dalarnas län, Sweden</Address>
</Location>
</StartLocation>
<Created>2015-04-01T13:19:29Z</Created>
<Assigned xsi:nil="true"/>
<Activated xsi:nil="true"/>
<Completed xsi:nil="true"/>
<Updated>2015-04-01T13:19:29Z</Updated>
<Scheduled xsi:nil="true"/>
<CreatorID>0</CreatorID>
<ApplicationID>4</ApplicationID>
<State>Unassigned</State>
<Workers/>
<Order xsi:nil="true"/>
</Job>
<Job>
<ID>2</ID>
<Description>Fix leaking pipe</Description>
<Comment>Valve in pipe replaced</Comment>
<StartLocation>
<Location>
<Position>
<Lat>157.90465</Lat>
<Lon>122.83984</Lon>
<Alt>0</Alt>
</Position>
<CountryName>Estonia</CountryName>
<AdministrativeAreaName>Järva sten</AdministrativeAreaName>
<SubAdministrativeAreaName>Tuh Parish</SubAdministrativeAreaName>
<CityName />
<StreetName>Ganna-Teeki-Huuksi</StreetName>
<StreetBox />
<Address>Ganna-Teeki-Huuksi, 53412 Järva sten, Estonia</Address>
</Location>
</StartLocation>
<Assigned>2015-04-01T13:40:47Z</Assigned>
<Activated>2015-04-01T13:40:53Z</Activated>
<Completed>2015-04-01T13:40:53Z</Completed>
<Scheduled xsi:nil="true" />
<State>Completed</State>
<Workers>
<Worker>
<ID>9</ID>
<Name>Worker</Name>
<JobID>2</JobID>
<State>Completed</State>
<ModInfo>Unmodified</ModInfo>
<NewState>Completed</NewState>
<ETATime xsi:nil="true" />
<ETADistance xsi:nil="true" />
<CommandID xsi:nil="true" />
<DispatcherID xsi:nil="true" />
</Worker>
</Workers>
<Order xsi:nil="true" />
</Job>
</GetJobsResult>
</GetJobsResponse>
</soap:Body>
</soap:Envelope>
GetAllChanges
Description
Get all jobs that have been created or updated within the last week. This is in most cases a better operation to perform
than GetJobs which will become very expensive to call.
Parameters
the request.
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetAllChanges"
HTTP XML Content

<soap:Body>
<GetAllChanges xmlns="http://gpsgate.com/services/">
</GetAllChanges>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<GetAllChanges xmlns="http://gpsgate.com/services/">
</GetAllChanges>
</soap:Body>
</soap:Envelope>
Typical Response

<ArrayOfJob xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://gpsgate.com/services/">
<Job>
<ID>1</ID>
<Comment/>
<StartLocation>
<Location>
<Position>
<Lat>135.6301</Lat>
<Lon>112.50195</Lon>
<Alt>0</Alt>
</Position>
<CityName/>
<StreetBox/>
</Location>
</StartLocation>
<Workers/>
</Job>
</ArrayOfJob>
GetChangesSince
Description
Get all jobs that have been created or updated since the provided date/time parameter.
Parameters
the request.
dtTime dateTime 2007-10-09T12:00:00Z The time starting from Yes
which to look for job
updates
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetChangesSince"
HTTP XML Content

<soap:Body>
<GetChangesSince xmlns="http://gpsgate.com/services/">
<dtTime>dateTime</dtTime>
</GetChangesSince>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<GetChangesSince xmlns="http://gpsgate.com/services/">
<dtTime>2007-10-09T12:00:00Z</dtTime>
</GetChangesSince>
</soap:Body>
</soap:Envelope>
Typical Response
<ArrayOfJob xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://gpsgate.com/services/">
<Job>
<ID>1</ID>
<Comment/>
<StartLocation>
<Location>
<Position>
<Lat>135.6301</Lat>
<Lon>112.50195</Lon>
<Alt>0</Alt>
</Position>
<CityName/>
<StreetBox/>
</Location>
</StartLocation>
<Workers/>
</Job>
</ArrayOfJob>
GetChangesForUsers
Description
Get all jobs that have been created or updated within the last week for the supplied array of user Ids.
Parameters
the request.
arrIds array of ints <int>1</int> An array of user IDs to Yes
<int>2</int> check for changes
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetChangesForUsers"
HTTP XML Content

<soap:Body>
<GetChangesForUsers xmlns="http://gpsgate.com/services/">
<arrIds>
<int>int</int>
<int>int</int>
</arrIds>
</GetChangesForUsers>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<GetChangesForUsers xmlns="http://gpsgate.com/services/">
<arrIds>
<int>1</int>
<int>2</int>
</arrIds>
</GetChangesForUsers>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<GetChangesForUsersResponse xmlns="http://gpsgate.com/services/">
<GetChangesForUsersResult>
<Job>
<ID>1</ID>
<Comment/>
<StartLocation>
<Location>
<Position>
<Lat>135.6301</Lat>
<Lon>112.50195</Lon>
<Alt>0</Alt>
</Position>
<CityName/>
<StreetBox/>
</Location>
</StartLocation>
<Workers/>
</Job>
</GetChangesForUsersResult>
</GetChangesForUsersResponse>
</soap:Body>
</soap:Envelope>
GetChangesForUsersSince
Description
Get all jobs that have been created or updated since the supplied date/time for the supplied array of user Ids.
Parameters
the request.
dtTime dateTime 2007-10-09T12:00:00Z The time starting from Yes
which to look for job
updates
arrIds array of ints <int>1</int> An array of user IDs to Yes
<int>2</int> check for changes
routeId int 3 Allow to select changes on No
a specific route
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetChangesForUsersSince"
HTTP XML Content

<soap:Body>
<GetChangesForUsersSince xmlns="http://gpsgate.com/services/">
<dtTime>dateTime</dtTime>
<arrIds>
<int>int</int>
<int>int</int>
</arrIds>
<routeId>int</routeId>
</GetChangesForUsersSince>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<GetChangesForUsersSince xmlns="http://gpsgate.com/services/">
<dtTime>2007-10-09T12:00:00Z</dtTime>
<arrIds>
<int>1</int>
<int>2</int>
</arrIds>
<routeId>2</routeId>
</GetChangesForUsersSince>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<GetChangesForUsersSinceResponse xmlns="http://gpsgate.com/services/">
<GetChangesForUsersSinceResult>
<Job>
<ID>1</ID>
<Comment/>
<StartLocation>
<Location>
<Position>
<Lat>135.6301</Lat>
<Lon>112.50195</Lon>
<Alt>0</Alt>
</Position>
<CityName/>
<StreetBox/>
</Location>
</StartLocation>
<Workers/>
</Job>
</GetChangesForUsersSinceResult>
</GetChangesForUsersSinceResponse>
</soap:Body>
</soap:Envelope>
SetComment
Description
Get all jobs that have been created or updated since the supplied date/time for the supplied array of user Ids.
Parameters
the request.
iJobId int 12345 ID of the job on which to set Yes
the comment
strComment string Completed The comment text that Yes
should be set
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/SetComment"
HTTP XML Content

<soap:Body>
<SetComment xmlns="http://gpsgate.com/services/">
<strComment>string</strComment>
</SetComment>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<SetComment xmlns="http://gpsgate.com/services/">
<iJobId>12345</iJobId>
<strComment>Completed</strComment>
</SetComment>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SetCommentResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
CreateRoute
Description
Create a Route by providing a name, optional notes, optional colour, and fill it with Jobs as described by the given
RouteJobs entities.
Parameters
the request.
strName string Delivery for InGen The name of the Route to Yes
be created
strNotes string Sale by Jeremy Some notes to attach to the No
route (for operators)
strColour string #ff0000 A valid CSS colour in No
hexadecimal or name
format to apply to the route
See:
https://drafts.csswg.org/css
-color-3/
arrRouteJobs Array of See Typical Request An array of RouteJob Yes. Min 2 RouteJobs.
RouteJobs entities. Routes should
contain at least two
RouteJobs
scheduledDispat DateTime 2016-09-13T16:07:00 To set a delayed Can be null
chingDate nullable dispatching Date. See
DelayedRouteDispatching
method for activation of the
task
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/CreateRoute"
HTTP XML Content

<soap:Body>
<CreateRoute xmlns="http://gpsgate.com/services/">
<scheduledDispatchingDate>DateTime</scheduledDispatchingDate>
<strName>string</strName>
<strNotes>string</strNotes>
<strColour>string</strColour>
<arrRouteJobs>
<RouteJob>
</RouteJob>
<RouteJob>
</RouteJob>
</arrRouteJobs>
</CreateRoute>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<CreateRoute xmlns="http://gpsgate.com/services/">
<strName>Delivery for InGen</strName>
<strNotes>Sale by Jeremy</strNotes>
<strColour>#ff0000</strColour>
<scheduledDispatchingDate>2016-09-13T16:07:00</scheduledDispatchingDate>
<arrRouteJobs>
<RouteJob>
<dblLatitude>59.326462</dblLatitude>
<dblLongitude>18.071883</dblLongitude>
<strDescription>Collect shipment</strDescription>
<dtDate>2015-04-01T13:19:29Z</dtDate>
</RouteJob>
<RouteJob>
<strDescription>Deliver shipment</strDescription>
<dtDate>2015-04-01T13:19:29Z</dtDate>
</RouteJob>
</arrRouteJobs>
</CreateRoute>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<CreateRouteResponse xmlns="http://gpsgate.com/services/">
<CreateRouteResult>1</CreateRouteResult>
</CreateRouteResponse>
</soap:Body>
</soap:Envelope>
DeleteRoute
Description
Delete an existing Dispatch Route by providing it's Route ID.
Parameters
to authenticate and
used for dispatch
iRouteId int 1 ID of the route to be Yes
deleted
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/DeleteRoute"
HTTP XML Content

<soap:Body>
<DeleteRoute xmlns="http://gpsgate.com/services/">
<iRouteId>int</iRouteId>
</DeleteRoute>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<DeleteRoute xmlns="http://gpsgate.com/services/">
<iRouteId>1</iRouteId>
</DeleteRoute>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<DeleteRouteResponse xmlns="http://gpsgate.com/services/" />
</soap:Body>
</soap:Envelope>
DispatchRoute
Description
Dispatch a route and it's contained Jobs to a worker by providing a Route ID and a Worker ID.
Parameters
the request.
iRouteId int 1 ID of the route to dispatch Yes
iWorkerId int 1 ID of the worker to dispatch Yes
the route to
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/DispatchRoute"
HTTP XML Content

<soap:Body>
<DispatchRoute xmlns="http://gpsgate.com/services/">
<iWorkerId>int</iWorkerId>
</DispatchRoute>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<DispatchRoute xmlns="http://gpsgate.com/services/">
<iWorkerId>1</iWorkerId>
</DispatchRoute>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<DispatchRouteResponse xmlns="http://gpsgate.com/services/" />
</soap:Body>
</soap:Envelope>
GetRoute
Description
When a Job belongs to a Route it contains an integer RouteId property. This call can be used to recover the associated
information that GpsGate holds on the Route for UI display purposes.
Parameters
the request.
iRouteId int 1 ID of route to recover Yes
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetRoute"
HTTP XML Content

<soap:Body>
<GetRoute xmlns="http://gpsgate.com/services/">
</GetRoute>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<GetRoute xmlns="http://gpsgate.com/services/">
</GetRoute>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<GetRouteResponse xmlns="http://gpsgate.com/services/">
<GetRouteResult>
<ID>1</ID>
<DateCreated>2015-04-01T13:19:29Z</DateCreated>
<Colour>#ff00ff </Colour>
<Name>First Route</Name>
<Notes>Make sure to knock on the door as the doorbell is broken</Notes>
<Order>0</Order>
<ContainedJobs>
<int>1</int>
<int>2</int>
</ContainedJobs>
</GetRouteResult>
</GetRouteResponse>
</soap:Body>
</soap:Envelope>
CreateOptimalRoute
Description
Create a Route by providing a name, optional notes, optional colour, and fill it with Jobs as described by the given
RouteJobs entities. The order of the Jobs are decided by an algorithm, that optimises the travel time of the Route.
Parameters
the request.
strName string Delivery for InGen The name of the Route to Yes
be created
strNotes string Sale by Jeremy Some notes to attach to the No
route (for operators)
strColour string #ff0000 A valid CSS colour in No
hexadecimal or name
format to apply to the route
See:
https://drafts.csswg.org/css
-color-3/
arrRouteJobs Array of See Typical Request An array of RouteJob Yes. Min 2 RouteJobs.
RouteJobs entities. Routes should
contain at least two
RouteJobs
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/CreateOptimalRoute"
HTTP XML Content

<soap:Body>
<CreateOptimalRoute xmlns="http://gpsgate.com/services/">
<strName>string</strName>
<strNotes>string</strNotes>
<strColour>string</strColour>
<arrRouteJobs>
<RouteJob>
</RouteJob>
<RouteJob>
</RouteJob>
</arrRouteJobs>
</CreateOptimalRoute>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<CreateOptimalRoute xmlns="http://gpsgate.com/services/">
<strName>Delivery for InGen</strName>
<strNotes>Sale by Jeremy</strNotes>
<strColour>#ff0000</strColour>
<arrRouteJobs>
<RouteJob>
<strDescription>Collect shipment</strDescription>
<dtDate>2015-04-01T13:19:29Z</dtDate>
</RouteJob>
<RouteJob>
<strDescription>Deliver shipment</strDescription>
<dtDate>2015-04-01T13:19:29Z</dtDate>
</RouteJob>
</arrRouteJobs>
</CreateOptimalRoute>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<CreateOptimalRouteResponse xmlns="http://gpsgate.com/services/">
<CreateOptimalRouteResult>1</CreateOptimalRouteResult>
</CreateOptimalRouteResponse>
</soap:Body>
</soap:Envelope>
OptimiseRoute
Description
Optimise an existing Route, provided by ID. The optimiser searches for the optimal order of the Route's Jobs, trying to
reduce the travel time of the Route.
Parameters
the request.
iRouteId int 12 ID of the Route to optimise Yes
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/OptimiseRoute"
HTTP XML Content

<soap:Body>
<OptimiseRoute xmlns="http://gpsgate.com/services/">
</OptimiseRoute>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<OptimiseRoute xmlns="http://gpsgate.com/services/">
</OptimiseRoute>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<OptimiseRouteResponse xmlns="http://gpsgate.com/services/">
<OptimiseRouteResult>
<TimeEstimate>3051</TimeEstimate>
<DistanceEstimate>26041</DistanceEstimate>
<RelativeJobOrders>
<int>1</int>
<int>0</int>
</RelativeJobOrders>
<DistanceValues>
<int>62</int>
<int>123</int>
</DistanceValues>
<Route>
<Loc>
<Lat>59.326462</Lat>
<Lng>18.071883</Lng>
</Loc>
<Loc>
<Lat>59.311681</Lat>
<Lng>18.087504</Lng>
</Loc>
</Route>
<ProgressPercentage>0</ProgressPercentage>
<Error></Error>
<ErrorArg />
<Directions />
</OptimiseRouteResult>
</OptimiseRouteResponse>
</soap:Body>
</soap:Envelope>
GetRouteSchedule
Description
This call can be used to recover the schedule from a given route thanks to its Id.
Parameters
the request.
iRouteId int 1 ID of route to recover the Yes
schedule from
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetRouteSchedule"
HTTP XML Content

<soap:Body>
<GetRouteSchedule xmlns="http://gpsgate.com/services/">
</GetRouteSchedule>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<GetRouteSchedule xmlns="http://gpsgate.com/services/">
</GetRouteSchedule>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<GetRouteScheduleResponse xmlns="http://gpsgate.com/services/">
<GetRouteScheduleResult>
<ID>2</ID>
<Sundays>false</Sundays>
<Mondays>false</Mondays>
<Tuesdays>false</Tuesdays>
<Wednesdays>false</Wednesdays>
<Thursdays>false</Thursdays>
<Fridays>true</Fridays>
<Saturdays>false</Saturdays>
<AssignWorker>false</AssignWorker>
</GetRouteScheduleResult>
</GetRouteScheduleResponse>
</soap:Body>
</soap:Envelope>
SetRouteSchedule
Description
This call can be used to recover the schedule from a given route thanks to its Id.
Parameters
strSessionID string 3085633935CCEA ID of the session from Yes
8D57A1A6DFA538 Login response. Used to
6EC4 authenticate and authorize
the request.
iRouteId int 1 ID of route to recover the Yes
schedule from
schedule SetScheduleObject See typical request An object representing the yes
schedule
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/SetRouteSchedule"
HTTP XML Content

<soap:Body>
<SetRouteSchedule xmlns="http://gpsgate.com/services/">
<schedule>
<SetScheduleObject>
<Sundays>bool</Sundays>
<Mondays>bool</Mondays>
<Tuesdays>bool</Tuesdays>
<Wednesdays>bool</Wednesdays>
<Thursdays>bool</Thursdays>
<Fridays>bool</Fridays>
<Saturdays>bool</Saturdays>
</SetScheduleObject>
</schedule>
</SetRouteSchedule>
</soap:Body>
</soap:Envelope>
Typical Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://gpsgate.com/services/">
<soapenv:Header/>
<soapenv:Body>
<ser:SetRouteSchedule>

<ser:strSessionID>A1A4393D99653D5A8BB6467434554C13</ser:strSessionID>
<ser:iApplicationID>6</ser:iApplicationID>
<ser:iRouteId>27</ser:iRouteId>

<ser:schedule>
<ser:Sundays>false</ser:Sundays>
<ser:Mondays>false</ser:Mondays>
<ser:Tuesdays>false</ser:Tuesdays>
<ser:Wednesdays>false</ser:Wednesdays>
<ser:Thursdays>true</ser:Thursdays>
<ser:Fridays>false</ser:Fridays>
<ser:Saturdays>false</ser:Saturdays>
</ser:schedule>
</ser:SetRouteSchedule>
</soapenv:Body>
</soapenv:Envelope>
Typical Response
<soap:Body>
<SetRouteScheduleResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
DelayedRouteDispatching
Description
This call can be used to create a task in the scheduler. This task will dispatch the given route at the given time. The route
must have been assigned workers previously.
If dateOfDispatch is null and overridePreviousDate false, it will create a task with the current saved dispatching
date of the route.
If dateOfDispatch is null and overridePreviousDate true it will remove the existing task from the scheduler and
dispatching will be canceled.
If dateOfDispatch is not null and overridePreviousDate true, it will remove any existing task from the scheduler
for this route, and creates a new one with the given date.
Parameters
authenticate and
applicationId int 4 ID of application. Yes
routeId int 1 ID of route to schedule Yes
the dispatching
DateOfDispatch DateTime nullable 2016-09-13T16:07:00 An object representing Can be null
the schedule
OverridePreviousD Bool TRUE Set to true if you want to Yes
ate override the previous
dispatching date. It will
remove the previous
task from the scheduler
if already exist. If True
and dateOfDispatch is
null it will only remove
the previous task and
cancel dispatching
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/DelayedRouteDispatching"
HTTP XML Content

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
<soap:Header/>
<soap:Body>
<ser:DelayedRouteDispatching>

<ser:sessionId>string</ser:sessionId>
<ser:applicationId>int</ser:applicationId>
<ser:routeId>int</ser:routeId>
<ser:dateOfDispatch>Datetime</ser:dateOfDispatch>
<ser:overridePreviousDate>bool</ser:overridePreviousDate>
</ser:DelayedRouteDispatching>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Header/>
<soap:Body>
<ser:DelayedRouteDispatching>

<ser:sessionId>1C7C9AAEC4B995DB0A05141802C3360D</ser:sessionId>
<ser:applicationId>6</ser:applicationId>
<ser:routeId>30</ser:routeId>
<ser:dateOfDispatch>2016-09-13T16:07:00</ser:dateOfDispatch>
<ser:overridePreviousDate>true</ser:overridePreviousDate>
</ser:DelayedRouteDispatching>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<DelayedRouteDispatchingResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
AssignJob
Description
This call can be used to assign a worker to the Job, or reassign it. Reassign will remove the previous worker and assign
to the current one. WorkerId needs to be greater than 0, otherwise it will do nothing.
Parameters
authenticate and
assigned to a worker
iWorkerId int 3 ID of the worker to be Yes
assigned to the Job
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/AssignJob"
HTTP XML Content

<soap:Header/>
<soap:Body>
<ser:AssignJob>

<ser:strSessionID>string</ser:strSessionID>
<ser:iApplicationID>int</ser:iApplicationID>
<ser:iJobId>int</ser:iJobId>
<ser:iWorkerId>int</ser:iWorkerId>
</ser:AssignJob>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Header/>
<soap:Body>
<ser:AssignJob>

<ser:strSessionID>959AD23D7CBC8CA88234C77374BAD08A</ser:strSessionID>
<ser:iJobId>15150</ser:iJobId>
<ser:iWorkerId>10</ser:iWorkerId>
</ser:AssignJob>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<AssignJobResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
AssignRoute
Description
This call can be used to assign a worker to the Route, or reassign it. Reassign will remove the previous worker and
assign to the current one. WorkerId needs to be greater than 0, otherwise it will do nothing.
Parameters
authenticate and
iRouteId int 1 ID of the Route to be Yes
assigned to a worker
iWorkerId int 3 ID of the worker to be Yes
assigned to the Route
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/AssignRoute"
HTTP XML Content

<soap:Header/>
<soap:Body>
<ser:AssignRoute>

<ser:iRouteId>int</ser:iRouteId>
<ser:iWorkerId>int</ser:iWorkerId>
</ser:AssignRoute>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Header/>
<soap:Body>
<ser:AssignRoute>

<ser:iWorkerId>10</ser:iWorkerId>
</ser:AssignRoute>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<AssignRouteResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
MoveJob
Description
This call can be used to add a Job to a Route. A Job that already has a Route will be moved to the new Route provided
in the parameters.
Parameters
authenticate and
iJobId int 1 ID of the Job to be Yes
moved
iRouteId int 3 ID of the Job's new Yes
Route
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/MoveJob"
HTTP XML Content

<soap:Header/>
<soap:Body>
<ser:MoveJob>

</ser:MoveJob>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Header/>
<soap:Body>
<ser:MoveJob>

</ser:MoveJob>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<MoveJobResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
GetJobInRange
Description
This call can be used to add a Job to a Route. A Job that already has a Route will be moved to the new Route provided
in the parameters.
Parameters
authenticate and
dFrom dateTime 2016-12-12T12:00:00Z Time interval lower limit Yes
dTo dateTime 2016-12-14T12:00:00Z Time interval upper limit Yes
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetJobsInRange"
HTTP XML Content

<soap:Header/>
<soap:Body>
<ser:GetJobsInRange>

<ser:dFrom>DateTime</ser:dFrom>
<ser:dTo>DateTime</ser:dTo>
</ser:GetJobsInRange>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Header/>
<soap:Body>
<ser:GetJobsInRange>

<ser:dFrom>2016-12-10T00:00:00</ser:dFrom>
<ser:dTo>2016-12-16T00:00:00</ser:dTo>
</ser:GetJobsInRange>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<GetJobsInRangeResponse xmlns="http://gpsgate.com/services/">
<GetJobsInRangeResult>
<Job>
<ID>22048</ID>
<Description>testJob03</Description>
<StartLocation>
<Location>
<Position>
<Lat>18.04738</Lat>
<Lon>59.34487</Lon>
<Alt>0</Alt>
</Position>
<CountryName/>
<AdministrativeAreaName/>
<CityName/>
<PostalCodeNumber/>
<StreetName/>
<StreetBox/>
<Address/>
<Neighborhood/>
</Location>
</StartLocation>
<Scheduled>2016-12-12T12:53:32Z</Scheduled>
<Workers/>
<RouteID xsi:nil="true"/>
<CustomFields>
<CustomFieldValueBags/>
<CustomFieldTemplateBag>
<Editable>true</Editable>
<ID>0</ID>
<TemplateID>0</TemplateID>
<DesignerID>2</DesignerID>
<CustomFieldTemplateItems/>
</CustomFieldTemplateBag>
</CustomFields>
<JobPOIId>0</JobPOIId>
<JobDuration>0</JobDuration>
</Job>
</GetJobsInRangeResult>
</GetJobsInRangeResponse>
</soap:Body>
</soap:Envelope>
UnassignJob
Description
This call can be used to unassign the current Worker from the Job.
Parameters
authenticate and
iJobId int 1 ID of the Job to be Yes
unassigned
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/UnassignJob"
HTTP XML Content

<soap:Header/>
<soap:Body>
<ser:UnassignJob>

</ser:UnassignJob>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Header/>
<soap:Body>
<ser:UnassignJob>

</ser:UnassignJob>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<UnassignJobResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
UnassignRoute
Description
This call can be used to unassign the current Worker from the Route.
Parameters
authenticate and
iRouteId int 1 ID of the Route to be Yes
unassigned
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/UnassignRoute"
HTTP XML Content

<soap:Header/>
<soap:Body>
<ser:UnassignRoute>

</ser:UnassignRoute>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Header/>
<soap:Body>
<ser:UnassignRoute>

</ser:UnassignRoute>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<UnassignRouteResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
PauseJob
Description
Set an existing job to the Completed state.
Parameters
the request.
for dispatch
completed
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/PauseJob"
HTTP XML Content

<soap:Body>
<PauseJob xmlns="http://gpsgate.com/services/">
</PauseJob>
</soap:Body>
</soap:Envelope>
Typical Request
<soap:Body>
<PauseJob xmlns="http://gpsgate.com/services/">
<iJobId>1</iJobId>
</PauseJob>
</soap:Body>
</soap:Envelope>
Typical Response
<soap:Body>
<PauseJobResponse xmlns="http://gpsgate.com/services/" />
</soap:Body>
</soap:Envelope>
GetJobCustomFields
Description
Return the custom fields for the given job Id
Parameters
sessionId string 3085633935CCEA8D57A1A6DFA ID of the session from Yes
the request.
appId int 4 ID of application being used Yes
for dispatch
jobId int 1 ID of the job to fetch Yes
customfield from
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetJobCustomFields"
HTTP XML Content

<soapenv:Header/>
<soapenv:Body>
<ser:GetJobCustomFields>

<ser:appId>int</ser:appId>
<ser:jobId>int</ser:jobId>
</ser:GetJobCustomFields>
</soapenv:Body>
</soapenv:Envelope>
Typical Request
<soapenv:Header/>
<soapenv:Body>
<ser:GetJobCustomFields>

<ser:sessionId>0A67F570B1B03EA39F96F98DB048E10E</ser:sessionId>
<ser:appId>6</ser:appId>
<ser:jobId>40158</ser:jobId>
</ser:GetJobCustomFields>
</soapenv:Body>
</soapenv:Envelope>
Typical Response
<soap:Body>
<GetJobCustomFieldsResponse xmlns="http://gpsgate.com/services/">
<GetJobCustomFieldsResult>
<SoapCustomField>
<Value>Update value from soap</Value>
<CFType>Text</CFType>
<DefaultValue/>
<CustomFieldValueId>1803</CustomFieldValueId>
</SoapCustomField>
<SoapCustomField>
<Value>true</Value>
<CFType>Checkbox</CFType>
<DefaultValue>no</DefaultValue>
</SoapCustomField>
<SoapCustomField>
<Value>test para</Value>
<CFType>Paragraph Text</CFType>
<DefaultValue/>
</SoapCustomField>
<SoapCustomField>
<Value>3</Value>
<CFType>List</CFType>
<DefaultValue>1<1>2<2>3<3>SelectedItem<</DefaultValue>
</SoapCustomField>
<SoapCustomField>
<Value>13</Value>
<CFType>Number</CFType>
<DefaultValue>10</DefaultValue>
</SoapCustomField>
</GetJobCustomFieldsResult>
</GetJobCustomFieldsResponse>
</soap:Body>
</soap:Envelope>
UpdateJobCustomField
Description
Update the custom fields for the given job Id and custom field Id, with the given value.
Parameters
sessionId string 3085633935CCEA8D57A ID of the session from Yes
1A6DFA5386EC4 Login response. Used to
the request.
for dispatch
jobId int 1 ID of the job to fetch Yes
customfield from
customfieldValueId int 1056 Id of the customfield to Yes
update
customFieldNewValue string My new value Value to update the custom yes
field with
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/UpdateJobCustomField"
HTTP XML Content

<soapenv:Header/>
<soapenv:Body>
<ser:UpdateJobCustomField>

<ser:customfieldValueId>int</ser:customfieldValueId>

<ser:customFieldNewValue>string</ser:customFieldNewValue>
</ser:UpdateJobCustomField>
</soapenv:Body>
</soapenv:Envelope>
Typical Request
<soapenv:Header/>
<soapenv:Body>
<ser:UpdateJobCustomField>


</ser:UpdateJobCustomField>
</soapenv:Body>
</soapenv:Envelope>
Typical Response
<soap:Body>
<UpdateJobCustomFieldResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
GetRouteCustomFields
Description
Return the custom fields for the given route Id
Parameters
sessionId string 3085633935CCEA8D57A1A6DFA ID of the session from Yes
the request.
for dispatch
routeId int 1 ID of the route to fetch Yes
customfield from
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetRouteCustomFields"
HTTP XML Content

<soapenv:Header/>
<soapenv:Body>
<ser:GetRouteCustomFields>

<ser:routeId>int</ser:routeId>
</ser:GetRouteCustomFields>
</soapenv:Body>
</soapenv:Envelope>
Typical Request
<soapenv:Header/>
<soapenv:Body>
<ser:GetRouteCustomFields>

<ser:sessionId>0A67F570B1B03EA39F96F98DB048E10E</ser:sessionId>
<ser:routeId>5</ser:routeId>
</ser:GetRouteCustomFields>
</soapenv:Body>
</soapenv:Envelope>
Typical Response
<soap:Body>
<GetRouteCustomFieldsResponse xmlns="http://gpsgate.com/services/">
<GetRouteCustomFieldsResult>
<SoapCustomField>
<Value>r texte</Value>
<CFType>Text</CFType>
<DefaultValue/>
</SoapCustomField>
<SoapCustomField>
<Value>r para</Value>
<CFType>Paragraph Text</CFType>
<DefaultValue/>
</SoapCustomField>
<SoapCustomField>
<Value>true</Value>
<CFType>Checkbox</CFType>
<DefaultValue>no</DefaultValue>
</SoapCustomField>
<SoapCustomField>
<Value>2</Value>
<CFType>List</CFType>
<DefaultValue>one<1>two<2>three<3>SelectedItem<</DefaultValue>
</SoapCustomField>
<SoapCustomField>
<Value>20</Value>
<CFType>Number</CFType>
<DefaultValue>10</DefaultValue>
</SoapCustomField>
</GetRouteCustomFieldsResult>
</GetRouteCustomFieldsResponse>
</soap:Body>
</soap:Envelope>
UpdateRouteCustomField
Description
Update the custom fields for the given job Id and custom field Id, with the given value.
Parameters
the request.
for dispatch
customfieldValueId int 1056 Id of the customfield to Yes
update
customFieldNewValue string My new value Value to update the custom yes
field with
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/UpdateRouteCustomField"
HTTP XML Content

<soapenv:Header/>
<soapenv:Body>
<ser:UpdateRouteCustomField>
</ser:UpdateRouteCustomField>
</soapenv:Body>
</soapenv:Envelope>
Typical Request
<soapenv:Header/>
<soapenv:Body>
<ser:UpdateRouteCustomField>
<ser:sessionId>37312DA8746AC38930DDAE658B6A7AA6</ser:sessionId>
<ser:customfieldValueId>1788</ser:customfieldValueId>
<ser:customFieldNewValue>coucou from route Cf update</ser:customFieldNewValue>

</ser:UpdateRouteCustomField>
</soapenv:Body>
</soapenv:Envelope>
Typical Response
<soap:Body>
<UpdateRouteCustomFieldResponse xmlns="http://gpsgate.com/services/"/>
</soap:Body>
</soap:Envelope>
GetWorkerId
Description
Fetch the user id for the current session Id and the given application Id.
Parameters
the request.
for dispatch
Request format
HTTP Headers
Host: localhost
SOAPAction: "http://gpsgate.com/services/GetWorkerId"
HTTP XML Content

<soapenv:Header/>
<soapenv:Body>
<ser:GetWorkerId>
</ser:GetWorkerId>
</soapenv:Body>
</soapenv:Envelope>
Typical Request
<soapenv:Header/>
<soapenv:Body>
<ser:GetWorkerId>

<ser:sessionId>9FADFC50BFA0301AA1F113AC18423CF5</ser:sessionId>
</ser:GetWorkerId>
</soapenv:Body>
</soapenv:Envelope>
Typical Response
<soap:Body>
<GetWorkerIdResponse xmlns="http://gpsgate.com/services/">
<GetWorkerIdResult>7</GetWorkerIdResult>
</GetWorkerIdResponse>
</soap:Body>
</soap:Envelope>
Error handling
Errors are returned using standard SOAP faults with the restrictions of the WS-I Basic Profile. This has the benefit that
autogenerated .NET client proxy code will throw a SoapException with the error message when such a response is
recieved.
Typical Error Response
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>This is an exception.</faultstring>
<detail/>
</soap:Fault>
</soap:Body>
</soap:Envelope>
Version History
Version 1.0
Introduction of the SOAP Dispatch Web Service.
Version 1.1
Addition of Routes.
Route and RouteJob objects added. GetRoute, CreateRoute, DeleteRoute and DispatchRoute calls added to the web
service.

SOAP POI Web Service Reference

Загружено:

Сведения о документе

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

SOAP POI Web Service Reference

Загружено:

Авторское право:

Доступные форматы

Table of Contents

Who should read this?

What can I do with this?

SOAP 1.1 Protocol specifications

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

<?xml version="1.0" encoding="utf-8"?>

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

HTTP XML Content

<ser:customFieldNewValue>coucou from route Cf update</ser:customFieldNewValue>

HTTP XML Content

Typical Error Response

Вам также может понравиться