Cochrane+ App API

<back to all web services

GetAttendanceSessionInfoRequest

Requires Authentication
The following routes are available for this service:
GET/attendance/sessioninfo
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey, IHasDeviceInfo):
    # @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    api_key: Optional[str] = None
    """
    The API Key required for authentication
    """


    # @ApiMember(DataType="double", Description="Latitude of the user making this request")
    latitude: float = 0.0
    """
    Latitude of the user making this request
    """


    # @ApiMember(DataType="double", Description="Longitude of the user making this request")
    longitude: float = 0.0
    """
    Longitude of the user making this request
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
    description: Optional[str] = None
    heading: Optional[str] = None
    was_successful: bool = False
    model_state: Optional[Object] = None


class AttendanceEventType(IntEnum):
    CLOCK_OUT = 0
    CLOCK_IN = 1
    START_LUNCH = 2
    END_LUNCH = 3
    START_BREAK = 4
    END_BREAK = 5


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttendanceEventData:
    type: Optional[AttendanceEventType] = None
    time: Optional[str] = None
    location: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttendanceSessionInfo:
    attendance_session_id: int = 0
    attendance_goal_time: float = 0.0
    attendance_goal_time_value: Optional[str] = None
    attendance_events: Optional[List[AttendanceEventData]] = None
    start_date: Optional[str] = None
    end_date: Optional[str] = None
    is_clocked_in: bool = False
    time_elapsed: float = 0.0
    latest_event_type: Optional[AttendanceEventType] = None
    total_break_time: float = 0.0
    total_lunch_time: float = 0.0
    is_new: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAttendanceSessionInfoResponse(ApiServiceResponse):
    session_info: Optional[AttendanceSessionInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAttendanceSessionInfoRequest(ApiServiceRequest):
    pass

Python GetAttendanceSessionInfoRequest DTOs

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":{}}