BokaMera.API.Host

<back to all web services

UserAgreementQuery

Requires Authentication
The following routes are available for this service:
GET/users/agreementGets latest not agreed agreement with optional history
import Foundation
import ServiceStack

// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class UserAgreementQuery : Codable
{
    public var userId:String

    required public init(){}
}

public class UserAgreementQueryResponse : Codable
{
    public var userId:String
    public var agreementId:String
    public var userAgreementCreated:Date?
    public var agreedToLatest:Bool
    public var documents:[String] = []
    //responseStatus:Object ignored. Type could not be extended in Swift

    required public init(){}
}


Swift UserAgreementQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /users/agreement HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UserAgreementCreated":"0001-01-01T00:00:00","AgreedToLatest":false,"Documents":["String"],"ResponseStatus":{}}