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

Namespace Global

    Namespace Field2Office.API.Model

        Public Partial Class Location
            Public Overridable Property y As Double
            Public Overridable Property x As Double
        End Class
    End Namespace

    Namespace Field2Office.API.Model.ArrivalDeparture

        '''<Summary>
        '''Service representing an ArrivalDeparture object in a workspace.
        '''</Summary>
        Public Partial Class ArrivalDeparture
            Public Overridable Property Workspace As String
            Public Overridable Property ObjectId As String
            Public Overridable Property ArrivalTime As String
            Public Overridable Property DepartureTime As String
            Public Overridable Property GeofenceLocation As Location
            Public Overridable Property GeofenceId As String
            Public Overridable Property GeofenceRadius As Double
            Public Overridable Property User As String
            Public Overridable Property Task As String
        End Class

        '''<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 Sub New()
                ArrivalDepartures = New List(Of ArrivalDeparture)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property ObjectId As String
            Public Overridable Property Days As String
            Public Overridable Property DateGenerated As String
            Public Overridable Property ArrivalDepartures As List(Of ArrivalDeparture)
        End Class
    End Namespace
End Namespace

VB.NET 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