Cochrane+ App API

<back to all web services

GetAttendanceSessionInfoRequest

Requires Authentication
The following routes are available for this service:
GET/attendance/sessioninfo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
GetAttendanceSessionInfoResponse Parameters:
NameParameterData TypeRequiredDescription
SessionInfoformAttendanceSessionInfoNo
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
HeadingformstringNo
WasSuccessfulformboolNo
ModelStateformObjectNo
AttendanceSessionInfo Parameters:
NameParameterData TypeRequiredDescription
AttendanceSessionIdformintNo
AttendanceGoalTimeformdoubleNo
AttendanceGoalTimeValueformstringNo
AttendanceEventsformList<AttendanceEventData>No
StartDateformstringNo
EndDateformstringNo
IsClockedInformboolNo
TimeElapsedformdoubleNo
LatestEventTypeformAttendanceEventTypeNo
TotalBreakTimeformdoubleNo
TotalLunchTimeformdoubleNo
IsNewformboolNo
AttendanceEventData Parameters:
NameParameterData TypeRequiredDescription
TypeformAttendanceEventTypeNo
TimeformstringNo
LocationformstringNo
AttendanceEventType Enum:
NameValue
ClockOut0
ClockIn1
StartLunch2
EndLunch3
StartBreak4
EndBreak5

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

HTTP + OTHER

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

GET /attendance/sessioninfo HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"sessionInfo":{"attendanceSessionId":0,"attendanceGoalTime":0,"attendanceGoalTimeValue":"00:00:00","attendanceEvents":[{}],"startDate":"String","endDate":"String","isClockedIn":false,"timeElapsed":0,"latestEventType":0,"totalBreakTime":0,"totalLunchTime":0,"isNew":false},"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}