Field Squared API Services

<back to all web services

ArrivalDepartureList

Returns a list of ArrivalDeparture objects, based on the criteria within the end point.
/{Workspace}/ArrivalDeparture/User/{ObjectId}/History/{Days}/ - GET - Return the history of a
specific user for X days, sorted by arrival date descending.
/{Workspace}/ArrivalDeparture/History/{Days} - GET - Return the history of all users for X days,
sorted by user descending then arrival date descending.
/{Workspace}/ArrivalDeparture/Current - GET - Return the latest arrival departure object for each
user, sorted by arrivaldate descending.
/{Workspace}/ArrivalDepartureList/Task/{ObjectId}/History/ - GET - Return the history of all arrival
departure objects related to a specific task.
/{Workspace}/ArrivalDepartureList/Contact/{ObjectId}/History/ - GET - Return the history of all arrival
departure objects related to a specific contact.

The following routes are available for this service:
GET/{Workspace}/ArrivalDepartureList/Current
GET/{Workspace}/ArrivalDepartureList/History/{Days}
GET/{Workspace}/ArrivalDepartureList/User/{ObjectId}/History/{Days}/
GET/{Workspace}/ArrivalDepartureList/Task/{ObjectId}/History/
GET/{Workspace}/ArrivalDepartureList/Contact/{ObjectId}/History/

export class Location
{
    public y: number;
    public x: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

/** @description Service representing an ArrivalDeparture object in a workspace. */
export class ArrivalDeparture
{
    public Workspace: string;
    public ObjectId: string;
    public ArrivalTime: string;
    public DepartureTime: string;
    public GeofenceLocation: Location;
    public GeofenceId: string;
    public GeofenceRadius: number;
    public User: string;
    public Task: string;

    public constructor(init?: Partial<ArrivalDeparture>) { (Object as any).assign(this, init); }
}

/** @description Returns a list of ArrivalDeparture objects, based on the criteria within the end point. /{Workspace}/ArrivalDeparture/User/{ObjectId}/History/{Days}/ - GET - Return the history of a specific user for X days, sorted by arrival date descending. /{Workspace}/ArrivalDeparture/History/{Days} - GET - Return the history of all users for X days, sorted by user descending then arrival date descending. /{Workspace}/ArrivalDeparture/Current - GET - Return the latest arrival departure object for each user, sorted by arrivaldate descending./{Workspace}/ArrivalDepartureList/Task/{ObjectId}/History/ - GET - Return the history of all arrival departure objects related to a specific task./{Workspace}/ArrivalDepartureList/Contact/{ObjectId}/History/ - GET - Return the history of all arrival departure objects related to a specific contact. */
export class ArrivalDepartureList
{
    public Workspace: string;
    public ObjectId: string;
    public Days: string;
    public DateGenerated: string;
    public ArrivalDepartures: ArrivalDeparture[];

    public constructor(init?: Partial<ArrivalDepartureList>) { (Object as any).assign(this, init); }
}

TypeScript ArrivalDepartureList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /{Workspace}/ArrivalDepartureList/Current HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv