Server

<back to all web services

GetOrders

Requires Authentication
The following routes are available for this service:
GET/Order
"use strict";
/** @typedef {'InProgress'|'Updating'|'Creating'|'Completed'} */
export var ProcessState;
(function (ProcessState) {
    ProcessState["InProgress"] = "InProgress"
    ProcessState["Updating"] = "Updating"
    ProcessState["Creating"] = "Creating"
    ProcessState["Completed"] = "Completed"
})(ProcessState || (ProcessState = {}));
export class OrderState {
    /** @param {{LastModified?:string,AuftragArten?:IList<OrderKind>,Bearbeitungsstatus?:ProcessState,AbgeschlossenDatum?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    LastModified;
    /** @type {IList<OrderKind>} */
    AuftragArten;
    /** @type {?ProcessState} */
    Bearbeitungsstatus;
    /** @type {?string} */
    AbgeschlossenDatum;
}
export class AppointmentStoreUser {
    /** @param {{MonteurGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    MonteurGuid;
}
export class AppointmentNutzeinheit {
    /** @param {{NutzeinheitGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    NutzeinheitGuid;
}
export class Appointment {
    /** @param {{Guid?:string,Von?:string,Bis?:string,Monteure?:IList<AppointmentStoreUser>,Nutzeinheiten?:IList<AppointmentNutzeinheit>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Von;
    /** @type {string} */
    Bis;
    /** @type {IList<AppointmentStoreUser>} */
    Monteure;
    /** @type {IList<AppointmentNutzeinheit>} */
    Nutzeinheiten;
}
export class NutzeinheitOrderPosition {
    /** @param {{NutzeinheitGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    NutzeinheitGuid;
}
export class OrderPosition {
    /** @param {{Guid?:string,LastModified?:string,Anmerkung?:string,SollMenge?:number,IstMenge?:number,NutzeinheitOrderPositions?:IList<NutzeinheitOrderPosition>,ArtikelGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {?string} */
    LastModified;
    /** @type {string} */
    Anmerkung;
    /** @type {number} */
    SollMenge;
    /** @type {number} */
    IstMenge;
    /** @type {IList<NutzeinheitOrderPosition>} */
    NutzeinheitOrderPositions;
    /** @type {string} */
    ArtikelGuid;
}
export class NutzeinheitOrderState {
    /** @param {{NutzeinheitGuid?:string,LastModified?:string,AuftragArten?:IList<NutzeinheitOrderKind>,Bearbeitungsstatus?:ProcessState,AbgeschlossenDatum?:string,OsVersion?:string,AppVersion?:string,OsPlatform?:string,AppGeraeteNummmer?:string,AmwInfoKeyGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    NutzeinheitGuid;
    /** @type {?string} */
    LastModified;
    /** @type {IList<NutzeinheitOrderKind>} */
    AuftragArten;
    /** @type {?ProcessState} */
    Bearbeitungsstatus;
    /** @type {?string} */
    AbgeschlossenDatum;
    /** @type {string} */
    OsVersion;
    /** @type {string} */
    AppVersion;
    /** @type {string} */
    OsPlatform;
    /** @type {string} */
    AppGeraeteNummmer;
    /** @type {?string} */
    AmwInfoKeyGuid;
}
/** @typedef {'Assembly'|'Maintenance'|'Exchange'|'Reading'|'Inspection'|'MainReading'} */
export var DeviceOrderKind;
(function (DeviceOrderKind) {
    DeviceOrderKind["Assembly"] = "Assembly"
    DeviceOrderKind["Maintenance"] = "Maintenance"
    DeviceOrderKind["Exchange"] = "Exchange"
    DeviceOrderKind["Reading"] = "Reading"
    DeviceOrderKind["Inspection"] = "Inspection"
    DeviceOrderKind["MainReading"] = "MainReading"
})(DeviceOrderKind || (DeviceOrderKind = {}));
export class DeviceOrderState {
    /** @param {{GeraeteGuid?:string,AuftragGuid?:string,AuftragArt?:DeviceOrderKind,Bearbeitungsstatus?:ProcessState,AbgeschlossenDatum?:string,AmwInfo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    GeraeteGuid;
    /** @type {string} */
    AuftragGuid;
    /** @type {?DeviceOrderKind} */
    AuftragArt;
    /** @type {?ProcessState} */
    Bearbeitungsstatus;
    /** @type {?string} */
    AbgeschlossenDatum;
    /** @type {string} */
    AmwInfo;
}
export class PersonCommunication {
    /** @param {{Guid?:string,LastModified?:string,Adresse?:string,Anmerkung?:string,KommunikationsFunktionGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {?string} */
    LastModified;
    /** @type {string} */
    Adresse;
    /** @type {string} */
    Anmerkung;
    /** @type {string} */
    KommunikationsFunktionGuid;
}
export class Person {
    /** @param {{Guid?:string,LastModified?:string,Nachname1?:string,Nachname2?:string,Nachname3?:string,Vorname1?:string,Vorname2?:string,Anmerkung?:string,Anrede?:string,Titel?:string,PersonKommunikationen?:PersonCommunication[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {?string} */
    LastModified;
    /** @type {string} */
    Nachname1;
    /** @type {string} */
    Nachname2;
    /** @type {string} */
    Nachname3;
    /** @type {string} */
    Vorname1;
    /** @type {string} */
    Vorname2;
    /** @type {string} */
    Anmerkung;
    /** @type {string} */
    Anrede;
    /** @type {string} */
    Titel;
    /** @type {PersonCommunication[]} */
    PersonKommunikationen;
}
export class Orderer {
    /** @param {{Guid?:string,Person?:Person,BetrieblichePosition?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {Person} */
    Person;
    /** @type {string} */
    BetrieblichePosition;
}
/** @typedef {'Nutzer'|'Technician'} */
export var SignatureKind;
(function (SignatureKind) {
    SignatureKind["Nutzer"] = "Nutzer"
    SignatureKind["Technician"] = "Technician"
})(SignatureKind || (SignatureKind = {}));
export class Signature {
    /** @param {{Guid?:string,Timestamp?:string,UnterschriftArt?:SignatureKind,NutzeinheitGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {?string} */
    Timestamp;
    /** @type {?SignatureKind} */
    UnterschriftArt;
    /** @type {string} */
    NutzeinheitGuid;
}
export class Order {
    /** @param {{Guid?:string,LastModified?:string,AbrechnungseinheitGuid?:string,AuftragNummer?:string,Bezeichnung?:string,Anmerkung?:string,UnterschriftBenoetigt?:boolean,Erstellungsdatum?:string,AuftragZustand?:OrderState,Termine?:IList<Appointment>,AuftragsPositionen?:IList<OrderPosition>,NutzeinheitZustaende?:IList<NutzeinheitOrderState>,GeraeteZustaende?:IList<DeviceOrderState>,Auftraggeber?:Orderer,Unterschriften?:IList<Signature>}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {?string} */
    LastModified;
    /** @type {string} */
    AbrechnungseinheitGuid;
    /** @type {string} */
    AuftragNummer;
    /** @type {string} */
    Bezeichnung;
    /** @type {string} */
    Anmerkung;
    /** @type {boolean} */
    UnterschriftBenoetigt;
    /** @type {string} */
    Erstellungsdatum;
    /** @type {OrderState} */
    AuftragZustand;
    /** @type {IList<Appointment>} */
    Termine;
    /** @type {IList<OrderPosition>} */
    AuftragsPositionen;
    /** @type {IList<NutzeinheitOrderState>} */
    NutzeinheitZustaende;
    /** @type {IList<DeviceOrderState>} */
    GeraeteZustaende;
    /** @type {Orderer} */
    Auftraggeber;
    /** @type {IList<Signature>} */
    Unterschriften;
}
export class GetOrdersResponse {
    /** @param {{orders?:IList<Order>,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IList<Order>} */
    orders;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetOrders {
    constructor(init) { Object.assign(this, init) }
}

JavaScript GetOrders 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 /Order HTTP/1.1 
Host: mi-waerme-servamw.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
		}
	}
}