Cochrane+ App API

<back to all web services

GetAttendanceSessionInfoRequest

Requires Authentication
The following routes are available for this service:
GET/attendance/sessioninfo
import Foundation
import ServiceStack

public class GetAttendanceSessionInfoRequest : ApiServiceRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public var latitude:Double

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public var longitude:Double

    required public init(){}
}

public class GetAttendanceSessionInfoResponse : ApiServiceResponse
{
    public var sessionInfo:AttendanceSessionInfo

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case sessionInfo
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        sessionInfo = try container.decodeIfPresent(AttendanceSessionInfo.self, forKey: .sessionInfo)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if sessionInfo != nil { try container.encode(sessionInfo, forKey: .sessionInfo) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    public var Description:String
    public var heading:String
    public var wasSuccessful:Bool
    //modelState:Object ignored. Type could not be extended in Swift

    required public init(){}
}

public class AttendanceSessionInfo : Codable
{
    public var attendanceSessionId:Int
    public var attendanceGoalTime:Double
    public var attendanceGoalTimeValue:String
    public var attendanceEvents:[AttendanceEventData] = []
    public var startDate:String
    public var endDate:String
    public var isClockedIn:Bool
    public var timeElapsed:Double
    public var latestEventType:AttendanceEventType
    public var totalBreakTime:Double
    public var totalLunchTime:Double
    public var isNew:Bool

    required public init(){}
}

public class AttendanceEventData : Codable
{
    public var type:AttendanceEventType
    public var time:String
    public var location:String

    required public init(){}
}

public enum AttendanceEventType : Int, Codable
{
    case ClockOut = 0
    case ClockIn = 1
    case StartLunch = 2
    case EndLunch = 3
    case StartBreak = 4
    case EndBreak = 5
}


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