BokaMera.API.Host

<back to all web services

AgreementQuery

The following routes are available for this service:
GET/agreementsGets agreements
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 AgreementQueryResponse:
    agreement_id: Optional[str] = None
    agreement_created: Optional[datetime.datetime] = None
    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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgreementQuery:
    pass

Python AgreementQuery 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 /agreements HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"AgreementCreated":"0001-01-01T00:00:00","Documents":["String"],"ResponseStatus":{}}