Server

<back to all web services

GetObjektList

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 CustomerObjekt:
    guid: Optional[str] = None
    range_from: datetime.datetime = datetime.datetime(1, 1, 1)
    range_to: Optional[datetime.datetime] = None
    is_customer: bool = False
    is_owner: bool = False
    is_owner_pseudo: bool = False
    objekt_guid: Optional[str] = None
    customer_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjektListResponse:
    customer_objekte_list: Optional[List[CustomerObjekt]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjektList(IHasBearerToken):
    # @ApiMember(IsRequired=true, ParameterType="query")
    bearer_token: Optional[str] = None

    # @ApiMember(ParameterType="query")
    include: Optional[str] = None

    # @ApiMember(Description="Optional! Follow the format : /api/v1/objekte?filter[Customer]=*", ParameterType="query")
    filter_by_customer: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/objekte?filter[Customer]=*
    """


    # @ApiMember(Description="Optional! Follow the format : /api/v1/objekte?filter[Number]=*", ParameterType="query")
    filter_by_number: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/objekte?filter[Number]=*
    """


    # @ApiMember(Description="Optional! Follow the format : /api/v1/objekte?filter[Address]=*", ParameterType="query")
    filter_by_address: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/objekte?filter[Address]=*
    """

Python GetObjektList DTOs

GET /api/v1/objekte/ HTTP/1.1 
Host: brendle-schneider-servdesk.eras-online.de 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}