Server

<back to all web services

GetCustomerOnlineStatus

Requires Authentication
The following routes are available for this service:
GET/CustomerOnlineStatus/{Guid}
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 CustomerAddress:
    address_guid: Optional[str] = None
    is_primary: bool = False
    address_kind_label: Optional[str] = None
    address_kind_typ: Optional[str] = None


@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 Customer:
    guid: Optional[str] = None
    name1: Optional[str] = None
    name2: Optional[str] = None
    name3: Optional[str] = None
    number: Optional[str] = None
    salutation: Optional[str] = None
    customer_addresses: Optional[List[CustomerAddress]] = None
    customer_objekte: Optional[List[CustomerObjekt]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Objekt:
    guid: Optional[str] = None
    number: Optional[str] = None
    is_completed: Optional[str] = None
    uvi: Optional[str] = None
    is_uvi_disabled: Optional[str] = None
    completed_date: Optional[datetime.datetime] = None
    address_guid: Optional[str] = None
    anmerkung_kundenportal: Optional[str] = None
    kundenportal_marked_done: bool = False
    marked_done_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingInformation:
    guid: Optional[str] = None
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    is_completed: bool = False
    has_nebenkosten: bool = False
    objekt_guid: Optional[str] = None
    anmerkung_kundenportal: Optional[str] = None
    kundenportal_marked_done: bool = False
    marked_done_at: Optional[datetime.datetime] = None
    kundenportal_marked_closed: bool = False
    marked_closed_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomerOnlineStatusResponse:
    kunde: Optional[Customer] = None
    objekte: Optional[List[Objekt]] = None
    billing_information: Optional[List[BillingInformation]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomerOnlineStatus:
    guid: Optional[str] = None

Python GetCustomerOnlineStatus DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /CustomerOnlineStatus/{Guid} HTTP/1.1 
Host: calotec-portal-servdesk.eras-online.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	kunde: 
	{
		Guid: String,
		Name1: String,
		Name2: String,
		Name3: String,
		Kundennummer: String,
		Anrede: String,
		KundenAdressen: 
		[
			{
				AdresseGuid: String,
				IstPrimaer: False,
				AdressTypBezeichnung: String,
				AdressTyp: String
			}
		],
		KundenObjekte: 
		[
			{
				Guid: String,
				ZeitraumVon: 0001-01-01T00:00:00Z,
				ZeitraumBis: 0001-01-01T00:00:00Z,
				IstKunde: False,
				IstEigentümer: False,
				IstEigentümerPseudo: False,
				ObjektGuid: String,
				KundeGuid: String
			}
		]
	},
	objekte: 
	[
		{
			Guid: String,
			Objektnummer: String,
			IstAbgeschlossen: String,
			Uvi: String,
			IsUviDisabled: String,
			AbgeschlossenDatum: 0001-01-01T00:00:00Z,
			AdressGuid: String,
			AnmerkungKundenportal: String,
			KundenportalMarkedDone: False,
			MarkedDoneAt: 0001-01-01T00:00:00Z
		}
	],
	billingInformation: 
	[
		{
			Guid: String,
			Von: 0001-01-01T00:00:00Z,
			Bis: 0001-01-01T00:00:00Z,
			IstAbgeschlossen: False,
			HatNebenkosten: False,
			ObjektGuid: String,
			AnmerkungKundenportal: String,
			KundenportalMarkedDone: False,
			MarkedDoneAt: 0001-01-01T00:00:00Z,
			KundenportalMarkedClosed: False,
			MarkedClosedAt: 0001-01-01T00:00:00Z
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}