Server

<back to all web services

GetOrder

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/Order/{Guid}
GetOrder Parameters:
NameParameterData TypeRequiredDescription
GuidpathGuidNo
GetOrderResponse Parameters:
NameParameterData TypeRequiredDescription
OrderformOrderNo
ResponseStatusformResponseStatusNo
Order Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
AbrechnungseinheitGuidformGuidNo
NumberformstringNo
LabelformstringNo
NoteformstringNo
IsSignatureRequiredformboolNo
CreatedDateformDateTimeNo
OrderStateformOrderStateNo
AppointmentsformIList<Appointment>No
OrderPositionsformIList<OrderPosition>No
NutzeinheitOrderStatesformIList<NutzeinheitOrderState>No
DeviceOrderStatesformIList<DeviceOrderState>No
OrdererformOrdererNo
SignaturesformIList<Signature>No
OrderState Parameters:
NameParameterData TypeRequiredDescription
LastModifiedformDateTime?No
KindsformIList<Nullable<OrderKind>>No
ProcessStateformProcessState?No
CompletedDateformDateTime?No
ProcessState Enum:
InProgress
Updating
Creating
Completed
Appointment Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
FromformDateTimeNo
ToformDateTimeNo
AppointmentStoreUsersformIList<AppointmentStoreUser>No
AppointmentNutzeinheitenformIList<AppointmentNutzeinheit>No
AppointmentStoreUser Parameters:
NameParameterData TypeRequiredDescription
StoreUserIdformGuidNo
AppointmentNutzeinheit Parameters:
NameParameterData TypeRequiredDescription
NutzeinheitGuidformGuidNo
OrderPosition Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
NoteformstringNo
RequiredQuantityformintNo
ActualQuantityformintNo
NutzeinheitOrderPositionsformIList<NutzeinheitOrderPosition>No
ArticleGuidformGuidNo
NutzeinheitOrderPosition Parameters:
NameParameterData TypeRequiredDescription
NutzeinheitGuidformGuidNo
NutzeinheitOrderState Parameters:
NameParameterData TypeRequiredDescription
NutzeinheitGuidformGuidNo
LastModifiedformDateTime?No
OrderKindsformIList<Nullable<NutzeinheitOrderKind>>No
ProcessStateformProcessState?No
CompletedDateformDateTime?No
OsVersionformstringNo
AppVersionformstringNo
OsPlatformformstringNo
AppDeviceNumberformstringNo
AmwInfoKeyGuidformGuid?No
DeviceOrderState Parameters:
NameParameterData TypeRequiredDescription
DeviceGuidformGuidNo
OrderGuidformGuidNo
OrderKindformDeviceOrderKind?No
ProcessStateformProcessState?No
CompletedDateformDateTime?No
AmwInfoformstringNo
DeviceOrderKind Enum:
AssemblyMontage
MaintenanceWartung
ExchangeEichaustausch
ReadingAblesung
InspectionPrüfung
MainReadingHauptablesung
Orderer Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
PersonformPersonNo
BusinessPositionformstringNo
Person Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
Lastname1formstringNo
Lastname2formstringNo
Lastname3formstringNo
Firstname1formstringNo
Firstname2formstringNo
NoteformstringNo
SalutationformstringNo
TitleformstringNo
PersonCommunicationsformIEnumerable<PersonCommunication>No
PersonCommunication Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LastModifiedformDateTime?No
AddressformstringNo
NoteformstringNo
CommunicationFeatureGuidformGuidNo
Signature Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
RecordedDateformDateTime?No
KindformSignatureKind?No
NutzeinheitGuidformGuidNo
SignatureKind Enum:
Nutzer
Technician

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 /App/{UserId}/Order/{Guid} HTTP/1.1 
Host: isp-plauen-servamw.eras-online.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	order: 
	{
		Guid: 00000000000000000000000000000000,
		LastModified: 0001-01-01T00:00:00Z,
		AbrechnungseinheitGuid: 00000000000000000000000000000000,
		AuftragNummer: String,
		Bezeichnung: String,
		Anmerkung: String,
		UnterschriftBenoetigt: False,
		Erstellungsdatum: 0001-01-01T00:00:00Z,
		AuftragZustand: 
		{
			LastModified: 0001-01-01T00:00:00Z,
			Bearbeitungsstatus: InProgress,
			AbgeschlossenDatum: 0001-01-01T00:00:00Z
		},
		Auftraggeber: 
		{
			Guid: 00000000000000000000000000000000,
			Person: 
			{
				Guid: 00000000000000000000000000000000,
				LastModified: 0001-01-01T00:00:00Z,
				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
		}
	}
}