Cochrane+ App API

<back to all web services

AttendanceSessionStatusChangeRequest

Requires Authentication
The following routes are available for this service:
POST/attendance/sessionstatus
AttendanceSessionStatusChangeRequest Parameters:
NameParameterData TypeRequiredDescription
AttendanceSessionIdbodyintNo
EventTypebodyAttendanceEventTypeNo
TimeZoneNamebodystringNo
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
LatitudeformdoubleNoLatitude of the user making this request
LongitudeformdoubleNoLongitude of the user making this request
AttendanceEventType Enum:
NameValue
ClockOut0
ClockIn1
StartLunch2
EndLunch3
StartBreak4
EndBreak5
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

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.

POST /attendance/sessionstatus HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	attendanceSessionId: 0,
	eventType: 0,
	timeZoneName: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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: {}
}