Service

<back to all web services

GetOrderHelperPerson

The following routes are available for this service:
GET/client/GetOrderHelper/{OrderId}
GetOrderHelperPerson Parameters:
NameParameterData TypeRequiredDescription
OrderIdpathlongNo
ClientOrderHelperResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PersonIdformlongNo
PicLinkformstringNo
PicLinkOrganisationformstringNo
NotificationTimeformDateTime?No
ReactionIdformintNo
ReactionTimeStampformDateTime?No
OrderIdformlong?No
OrderSeriesIdformlong?No
NotificationsCreatedformboolNo
ForeNameformstringNo
LastNameformstringNo
OrganisationIdformlong?No
CompanyformstringNo
AddressformClientAddressResponseNo
OverallRatingformdecimalNo
CriminalRecordCertificateformboolNo
IsSchooledHelperformboolNo
PricePerUnitformdecimalNo
PricesformList<decimal>No
PreferedToPinformboolNo
NotesformstringNo
AvailabilityDeclaredDateformDateTimeNo
TrainingCertificatesformList<ClientPersonDocumentResponse>No
SendSepaViaClientPortalformboolNo
ClientAddressResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
PersonIdformlongNo
StreetformstringNo
BuildingNoformstringNo
PostCodeformstringNo
DistrictformstringNo
CityformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
AddressSupplementformstringNo
ClientPersonDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PersonIdformlongNo
NameformstringNo
DocumentTypeIdformintNo
DocumentOriginformintNo
DateOfIssuanceformDateTime?No
IsDeletedformboolNo

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 /client/GetOrderHelper/{OrderId} HTTP/1.1 
Host: api.helferportal.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	PersonId: 0,
	PicLink: String,
	PicLinkOrganisation: String,
	NotificationTime: 0001-01-01,
	ReactionId: 0,
	ReactionTimeStamp: 0001-01-01,
	OrderId: 0,
	OrderSeriesId: 0,
	NotificationsCreated: False,
	ForeName: String,
	LastName: String,
	OrganisationId: 0,
	Company: String,
	Address: 
	{
		Id: 0,
		AccountId: 0,
		PersonId: 0,
		Street: String,
		BuildingNo: String,
		PostCode: String,
		District: String,
		City: String,
		Latitude: 0,
		Longitude: 0,
		AddressSupplement: String
	},
	OverallRating: 0,
	CriminalRecordCertificate: False,
	IsSchooledHelper: False,
	PricePerUnit: 0,
	Prices: 
	[
		0
	],
	PreferedToPin: False,
	Notes: String,
	AvailabilityDeclaredDate: 0001-01-01,
	TrainingCertificates: 
	[
		{
			Id: 0,
			PersonId: 0,
			Name: String,
			DocumentTypeId: 0,
			DocumentOrigin: 0,
			DateOfIssuance: 0001-01-01,
			IsDeleted: False
		}
	],
	SendSepaViaClientPortal: False
}