Server

<back to all web services

GetOrder

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/Order/{Guid}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Amw.Service.Server.ServiceModel.Eras2Client.Order
Imports Eras2Amw.Service.Server.ServiceModel.Common
Imports Eras2Amw.Service.Server.ServiceModel.Enums
Imports Eras2Amw.Service.Server.ServiceModel.Eras2WebApp

Namespace Global

    Namespace Eras2Amw.Service.Server.ServiceModel.Common

        <DataContract>
        Public Partial Class Appointment
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid

            <DataMember(Name:="Von")>
            Public Overridable Property From As Date

            <DataMember(Name:="Bis")>
            Public Overridable Property To As Date

            <DataMember(Name:="Monteure")>
            Public Overridable Property AppointmentStoreUsers As IList(Of AppointmentStoreUser)

            <DataMember(Name:="Nutzeinheiten")>
            Public Overridable Property AppointmentNutzeinheiten As IList(Of AppointmentNutzeinheit)
        End Class

        <DataContract>
        Public Partial Class AppointmentNutzeinheit
            <DataMember(Name:="NutzeinheitGuid")>
            Public Overridable Property NutzeinheitGuid As Guid
        End Class

        <DataContract>
        Public Partial Class AppointmentStoreUser
            <DataMember(Name:="MonteurGuid")>
            Public Overridable Property StoreUserId As Guid
        End Class

        <DataContract>
        Public Partial Class NutzeinheitOrderPosition
            <DataMember(Name:="NutzeinheitGuid")>
            Public Overridable Property NutzeinheitGuid As Guid
        End Class

        <DataContract>
        Public Partial Class NutzeinheitOrderState
            <DataMember(Name:="NutzeinheitGuid")>
            Public Overridable Property NutzeinheitGuid As Guid

            <DataMember(Name:="LastModified")>
            Public Overridable Property LastModified As Nullable(Of Date)

            <DataMember(Name:="AuftragArten")>
            Public Overridable Property OrderKinds As IList(Of Nullable(Of NutzeinheitOrderKind))

            <DataMember(Name:="Bearbeitungsstatus")>
            Public Overridable Property ProcessState As Nullable(Of ProcessState)

            <DataMember(Name:="AbgeschlossenDatum")>
            Public Overridable Property CompletedDate As Nullable(Of Date)

            <DataMember(Name:="OsVersion")>
            Public Overridable Property OsVersion As String

            <DataMember(Name:="AppVersion")>
            Public Overridable Property AppVersion As String

            <DataMember(Name:="OsPlatform")>
            Public Overridable Property OsPlatform As String

            <DataMember(Name:="AppGeraeteNummmer")>
            Public Overridable Property AppDeviceNumber As String

            <DataMember(Name:="AmwInfoKeyGuid")>
            Public Overridable Property AmwInfoKeyGuid As Nullable(Of Guid)
        End Class

        <DataContract>
        Public Partial Class Order
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid

            <DataMember(Name:="LastModified")>
            Public Overridable Property LastModified As Nullable(Of Date)

            <DataMember(Name:="AbrechnungseinheitGuid")>
            Public Overridable Property AbrechnungseinheitGuid As Guid

            <DataMember(Name:="AuftragNummer")>
            Public Overridable Property Number As String

            <DataMember(Name:="Bezeichnung")>
            Public Overridable Property Label As String

            <DataMember(Name:="Anmerkung")>
            Public Overridable Property Note As String

            <DataMember(Name:="UnterschriftBenoetigt")>
            Public Overridable Property IsSignatureRequired As Boolean

            <DataMember(Name:="Erstellungsdatum")>
            Public Overridable Property CreatedDate As Date

            <DataMember(Name:="AuftragZustand")>
            Public Overridable Property OrderState As OrderState

            <DataMember(Name:="Termine")>
            Public Overridable Property Appointments As IList(Of Appointment)

            <DataMember(Name:="AuftragsPositionen")>
            Public Overridable Property OrderPositions As IList(Of OrderPosition)

            <DataMember(Name:="NutzeinheitZustaende")>
            Public Overridable Property NutzeinheitOrderStates As IList(Of NutzeinheitOrderState)

            <DataMember(Name:="GeraeteZustaende")>
            Public Overridable Property DeviceOrderStates As IList(Of DeviceOrderState)

            <DataMember(Name:="Auftraggeber")>
            Public Overridable Property Orderer As Orderer

            <DataMember(Name:="Unterschriften")>
            Public Overridable Property Signatures As IList(Of Signature)
        End Class

        <DataContract>
        Public Partial Class Orderer
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid

            <DataMember(Name:="Person")>
            Public Overridable Property Person As Person

            <DataMember(Name:="BetrieblichePosition")>
            Public Overridable Property BusinessPosition As String
        End Class

        <DataContract>
        Public Partial Class OrderPosition
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid

            <DataMember(Name:="LastModified")>
            Public Overridable Property LastModified As Nullable(Of Date)

            <DataMember(Name:="Anmerkung")>
            Public Overridable Property Note As String

            <DataMember(Name:="SollMenge")>
            Public Overridable Property RequiredQuantity As Integer

            <DataMember(Name:="IstMenge")>
            Public Overridable Property ActualQuantity As Integer

            <DataMember(Name:="NutzeinheitOrderPositions")>
            Public Overridable Property NutzeinheitOrderPositions As IList(Of NutzeinheitOrderPosition)

            <DataMember(Name:="ArtikelGuid")>
            Public Overridable Property ArticleGuid As Guid
        End Class

        <DataContract>
        Public Partial Class OrderState
            <DataMember(Name:="LastModified")>
            Public Overridable Property LastModified As Nullable(Of Date)

            <DataMember(Name:="AuftragArten")>
            Public Overridable Property Kinds As IList(Of Nullable(Of OrderKind))

            <DataMember(Name:="Bearbeitungsstatus")>
            Public Overridable Property ProcessState As Nullable(Of ProcessState)

            <DataMember(Name:="AbgeschlossenDatum")>
            Public Overridable Property CompletedDate As Nullable(Of Date)
        End Class

        <DataContract>
        Public Partial Class Person
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid

            <DataMember(Name:="LastModified")>
            Public Overridable Property LastModified As Nullable(Of Date)

            <DataMember(Name:="Nachname1")>
            Public Overridable Property Lastname1 As String

            <DataMember(Name:="Nachname2")>
            Public Overridable Property Lastname2 As String

            <DataMember(Name:="Nachname3")>
            Public Overridable Property Lastname3 As String

            <DataMember(Name:="Vorname1")>
            Public Overridable Property Firstname1 As String

            <DataMember(Name:="Vorname2")>
            Public Overridable Property Firstname2 As String

            <DataMember(Name:="Anmerkung")>
            Public Overridable Property Note As String

            <DataMember(Name:="Anrede")>
            Public Overridable Property Salutation As String

            <DataMember(Name:="Titel")>
            Public Overridable Property Title As String

            <DataMember(Name:="PersonKommunikationen")>
            Public Overridable Property PersonCommunications As IEnumerable(Of PersonCommunication)
        End Class

        <DataContract>
        Public Partial Class PersonCommunication
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid

            <DataMember(Name:="LastModified")>
            Public Overridable Property LastModified As Nullable(Of Date)

            <DataMember(Name:="Adresse")>
            Public Overridable Property Address As String

            <DataMember(Name:="Anmerkung")>
            Public Overridable Property Note As String

            <DataMember(Name:="KommunikationsFunktionGuid")>
            Public Overridable Property CommunicationFeatureGuid As Guid
        End Class

        <DataContract>
        Public Partial Class Signature
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid

            <DataMember(Name:="Timestamp")>
            Public Overridable Property RecordedDate As Nullable(Of Date)

            <DataMember(Name:="UnterschriftArt")>
            Public Overridable Property Kind As Nullable(Of SignatureKind)

            <DataMember(Name:="NutzeinheitGuid")>
            Public Overridable Property NutzeinheitGuid As Guid
        End Class
    End Namespace

    Namespace Eras2Amw.Service.Server.ServiceModel.Enums

        Public Enum DeviceOrderKind
            Assembly
            Maintenance
            Exchange
            Reading
            Inspection
            MainReading
        End Enum

        Public Enum ProcessState
            InProgress
            Updating
            Creating
            Completed
        End Enum

        Public Enum SignatureKind
            Nutzer
            Technician
        End Enum
    End Namespace

    Namespace Eras2Amw.Service.Server.ServiceModel.Eras2Client.Order

        <DataContract>
        Public Partial Class GetOrder
            <DataMember(Name:="Guid")>
            Public Overridable Property Guid As Guid
        End Class

        Public Partial Class GetOrderResponse
            Public Overridable Property Order As Order
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace Eras2Amw.Service.Server.ServiceModel.Eras2WebApp

        <DataContract>
        Public Partial Class DeviceOrderState
            <DataMember(Name:="GeraeteGuid")>
            Public Overridable Property DeviceGuid As Guid

            <DataMember(Name:="AuftragGuid")>
            Public Overridable Property OrderGuid As Guid

            <DataMember(Name:="AuftragArt")>
            Public Overridable Property OrderKind As Nullable(Of DeviceOrderKind)

            <DataMember(Name:="Bearbeitungsstatus")>
            Public Overridable Property ProcessState As Nullable(Of ProcessState)

            <DataMember(Name:="AbgeschlossenDatum")>
            Public Overridable Property CompletedDate As Nullable(Of Date)

            <DataMember(Name:="AmwInfo")>
            Public Overridable Property AmwInfo As String
        End Class
    End Namespace
End Namespace

VB.NET 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: isp-plauen-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"}}}