ConsumerApi

StatusRequest

ConsumerBusinessBackoffice

The following routes are available for this service:
GET	/status	Verify that the service runs correctly.	The reply itself is a verification of success, and causes a warmup, furthermore contact with database and other required services is checked.

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

# module ConsumerApi


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StatusResponse:
    database_connection_ok: bool = False
    search_connection_ok: bool = False
    deployed_version: Optional[str] = None
    deployed_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StatusRequest(IGet):
    pass

Python StatusRequest 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 /status HTTP/1.1 
Host: consumer-api.brovs.com 
Accept: application/xml

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

<StatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <DatabaseConnectionOk>false</DatabaseConnectionOk>
  <DeployedAt xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DeployedAt>
  <DeployedVersion>String</DeployedVersion>
  <SearchConnectionOk>false</SearchConnectionOk>
</StatusResponse>