| GET | /attendance/sessioninfo |
|---|
export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public apiKey: string;
/** @description Latitude of the user making this request */
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
public latitude: number;
/** @description Longitude of the user making this request */
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
public longitude: number;
public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}
export class ApiServiceResponse implements IServiceResponse
{
public description: string;
public heading: string;
public wasSuccessful: boolean;
public modelState: Object;
public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}
export enum AttendanceEventType
{
ClockOut = 0,
ClockIn = 1,
StartLunch = 2,
EndLunch = 3,
StartBreak = 4,
EndBreak = 5,
}
export class AttendanceEventData
{
public type: AttendanceEventType;
public time: string;
public location: string;
public constructor(init?: Partial<AttendanceEventData>) { (Object as any).assign(this, init); }
}
export class AttendanceSessionInfo
{
public attendanceSessionId: number;
public attendanceGoalTime: number;
public attendanceGoalTimeValue: string;
public attendanceEvents: AttendanceEventData[];
public startDate: string;
public endDate: string;
public isClockedIn: boolean;
public timeElapsed: number;
public latestEventType: AttendanceEventType;
public totalBreakTime: number;
public totalLunchTime: number;
public isNew: boolean;
public constructor(init?: Partial<AttendanceSessionInfo>) { (Object as any).assign(this, init); }
}
export class GetAttendanceSessionInfoResponse extends ApiServiceResponse
{
public sessionInfo: AttendanceSessionInfo;
public constructor(init?: Partial<GetAttendanceSessionInfoResponse>) { super(init); (Object as any).assign(this, init); }
}
export class GetAttendanceSessionInfoRequest extends ApiServiceRequest
{
public constructor(init?: Partial<GetAttendanceSessionInfoRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript GetAttendanceSessionInfoRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
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: {}
}