Cochrane+ App API

<back to all web services

GetAttendanceHistory

Requires Authentication
The following routes are available for this service:
GET/attendance/history

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 class AttendanceHistoryData
{
    public attendanceSessionId: number;
    public date: string;
    public attendanceTotal: string;
    public breakTotal: string;
    public lunchTotal: string;

    public constructor(init?: Partial<AttendanceHistoryData>) { (Object as any).assign(this, init); }
}

export class GetAttendanceHistoryResponse extends ApiServiceResponse
{
    public attendanceSessions: AttendanceHistoryData[];

    public constructor(init?: Partial<GetAttendanceHistoryResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetAttendanceHistory extends ApiServiceRequest
{
    // @ApiMember(IsRequired=true)
    public date: string;

    public constructor(init?: Partial<GetAttendanceHistory>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetAttendanceHistory DTOs

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/history HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"attendanceSessions":[{}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}