Antel Merchandiser App API

<back to all web services

GetCurrentAttendance

Requires Authentication
The following routes are available for this service:
GET/attendance/current
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
AttendanceResponse Parameters:
NameParameterData TypeRequiredDescription
ClockedInSessionsForDayformdoubleNo
TypeformAttendanceTypeNo
TypeStringformstringYes
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
ResponseStatusformResponseStatusYes
AttendanceType Enum:
NameValue
ClockedIn0
ClockedOut1

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /attendance/current HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ClockedInSessionsForDay":0,"Type":0,"TypeString":"Clocked In","Description":"String","Heading":"String","WasSuccessful":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}