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 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 UserAgreementQueryResponse:
    user_id: Optional[str] = None
    agreement_id: Optional[str] = None
    user_agreement_created: Optional[datetime.datetime] = None
    agreed_to_latest: bool = False
    documents: Optional[List[str]] = None
    response_status: Optional[Object] = None


# @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")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserAgreementQuery:
    user_id: Optional[str] = None

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