Server

<back to all web services

GetOrder

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/Order/{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


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 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


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderPosition:
    guid: Optional[str] = None
    last_modified: Optional[datetime.datetime] = None
    note: Optional[str] = None
    required_quantity: int = 0
    actual_quantity: int = 0
    nutzeinheit_order_positions: Optional[IList[NutzeinheitOrderPosition]] = None
    article_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NutzeinheitOrderState:
    nutzeinheit_guid: Optional[str] = None
    last_modified: Optional[datetime.datetime] = None
    order_kinds: Optional[IList[NutzeinheitOrderKind]] = None
    process_state: Optional[ProcessState] = None
    completed_date: Optional[datetime.datetime] = None
    os_version: Optional[str] = None
    app_version: Optional[str] = None
    os_platform: Optional[str] = None
    app_device_number: Optional[str] = None
    amw_info_key_guid: Optional[str] = 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 PersonCommunication:
    guid: Optional[str] = None
    last_modified: Optional[datetime.datetime] = None
    address: Optional[str] = None
    note: Optional[str] = None
    communication_feature_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Person:
    guid: Optional[str] = None
    last_modified: Optional[datetime.datetime] = None
    lastname1: Optional[str] = None
    lastname2: Optional[str] = None
    lastname3: Optional[str] = None
    firstname1: Optional[str] = None
    firstname2: Optional[str] = None
    note: Optional[str] = None
    salutation: Optional[str] = None
    title: Optional[str] = None
    person_communications: Optional[List[PersonCommunication]] = None


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


class SignatureKind(str, Enum):
    NUTZER = 'Nutzer'
    TECHNICIAN = 'Technician'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Signature:
    guid: Optional[str] = None
    recorded_date: Optional[datetime.datetime] = None
    kind: Optional[SignatureKind] = None
    nutzeinheit_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order:
    guid: Optional[str] = None
    last_modified: Optional[datetime.datetime] = None
    abrechnungseinheit_guid: Optional[str] = None
    number: Optional[str] = None
    label: Optional[str] = None
    note: Optional[str] = None
    is_signature_required: bool = False
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    order_state: Optional[OrderState] = None
    appointments: Optional[IList[Appointment]] = None
    order_positions: Optional[IList[OrderPosition]] = None
    nutzeinheit_order_states: Optional[IList[NutzeinheitOrderState]] = None
    device_order_states: Optional[IList[DeviceOrderState]] = None
    orderer: Optional[Orderer] = None
    signatures: Optional[IList[Signature]] = None


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


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

Python GetOrder DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /App/{UserId}/Order/{Guid} HTTP/1.1 
Host: andreiuologmbh-servamw.eras-online.de 
Accept: application/json

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

{"order":{"Guid":"00000000000000000000000000000000","LastModified":"0001-01-01T00:00:00.0000000Z","AbrechnungseinheitGuid":"00000000000000000000000000000000","AuftragNummer":"String","Bezeichnung":"String","Anmerkung":"String","UnterschriftBenoetigt":false,"Erstellungsdatum":"0001-01-01T00:00:00.0000000Z","AuftragZustand":{"LastModified":"0001-01-01T00:00:00.0000000Z","Bearbeitungsstatus":"InProgress","AbgeschlossenDatum":"0001-01-01T00:00:00.0000000Z"},"Auftraggeber":{"Guid":"00000000000000000000000000000000","Person":{"Guid":"00000000000000000000000000000000","LastModified":"0001-01-01T00:00:00.0000000Z","Nachname1":"String","Nachname2":"String","Nachname3":"String","Vorname1":"String","Vorname2":"String","Anmerkung":"String","Anrede":"String","Titel":"String"},"BetrieblichePosition":"String"}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}