BokaMera.API.Host

AgreementQuery

The following routes are available for this service:
GET	/agreements	Gets 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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgreementQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AgreementCreated>0001-01-01T00:00:00</AgreementCreated>
  <AgreementId>00000000-0000-0000-0000-000000000000</AgreementId>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Documents>
  <ResponseStatus />
</AgreementQueryResponse>