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/
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.ArrivalDeparture;
using Field2Office.API.Model;

namespace Field2Office.API.Model
{
    public partial class Location
    {
        public virtual double y { get; set; }
        public virtual double x { get; set; }
    }

}

namespace Field2Office.API.Model.ArrivalDeparture
{
    ///<summary>
    ///Service representing an ArrivalDeparture object in a workspace.
    ///</summary>
    public partial class ArrivalDeparture
    {
        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string ArrivalTime { get; set; }
        public virtual string DepartureTime { get; set; }
        public virtual Location GeofenceLocation { get; set; }
        public virtual string GeofenceId { get; set; }
        public virtual double GeofenceRadius { get; set; }
        public virtual string User { get; set; }
        public virtual string Task { get; set; }
    }

    ///<summary>
    ///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.
    ///</summary>
    public partial class ArrivalDepartureList
    {
        public ArrivalDepartureList()
        {
            ArrivalDepartures = new List<ArrivalDeparture>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string Days { get; set; }
        public virtual string DateGenerated { get; set; }
        public virtual List<ArrivalDeparture> ArrivalDepartures { get; set; }
    }

}

C# 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