Server

<back to all web services

GetAppointment

Requires Authentication
The following routes are available for this service:
GET/Appointment/{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 Address:
    guid: Optional[str] = None
    street: Optional[str] = None
    street2: Optional[str] = None
    street_number: Optional[str] = None
    zipcode: Optional[str] = None
    city: Optional[str] = None
    mailbox: Optional[str] = None
    additional: Optional[str] = None
    latitude: float = 0.0
    longitude: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Abrechnungseinheit:
    guid: Optional[str] = None
    number: Optional[str] = None
    note: Optional[str] = None
    address: Optional[Address] = None


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


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Appointment:
    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)
    appointment_store_users: Optional[IList[AppointmentStoreUser]] = None
    appointment_nutzeinheiten: Optional[IList[AppointmentNutzeinheit]] = None


class ProcessState(str, Enum):
    IN_PROGRESS = 'InProgress'
    UPDATING = 'Updating'
    CREATING = 'Creating'
    COMPLETED = 'Completed'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderState:
    last_modified: Optional[datetime.datetime] = None
    kinds: Optional[IList[OrderKind]] = None
    process_state: Optional[ProcessState] = None
    completed_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order:
    guid: Optional[str] = None
    abrechnungseinheit: Optional[Abrechnungseinheit] = None
    number: Optional[str] = None
    label: Optional[str] = None
    note: Optional[str] = None
    appointments: Optional[IList[Appointment]] = None
    order_state: Optional[OrderState] = None


class DeviceOrderKind(str, Enum):
    ASSEMBLY = 'Assembly'
    MAINTENANCE = 'Maintenance'
    EXCHANGE = 'Exchange'
    READING = 'Reading'
    INSPECTION = 'Inspection'
    MAIN_READING = 'MainReading'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeviceOrderState:
    device_guid: Optional[str] = None
    order_guid: Optional[str] = None
    order_kind: Optional[DeviceOrderKind] = None
    process_state: Optional[ProcessState] = None
    completed_date: Optional[datetime.datetime] = None
    amw_info: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAppointmentResponse:
    order: Optional[Order] = None
    back_device_states: Optional[List[DeviceOrderState]] = None
    response_status: Optional[ResponseStatus] = None


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

Python GetAppointment 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 /Appointment/{Guid} HTTP/1.1 
Host: immo-account-servamw.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAppointmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2Client.Order">
  <Appointment xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Common">
    <d2p1:Bis>0001-01-01T00:00:00</d2p1:Bis>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:Monteure i:nil="true" />
    <d2p1:Nutzeinheiten i:nil="true" />
    <d2p1:Von>0001-01-01T00:00:00</d2p1:Von>
  </Appointment>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetAppointmentResponse>