Service

<back to all web services

GetClientOrdersByState

The following routes are available for this service:
GET/client/Orders/{status}
GetClientOrdersByState Parameters:
NameParameterData TypeRequiredDescription
StatuspathOrderStatusNo

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

[
	{
		Id: 0,
		AccountId: 0,
		Status: None,
		OrderDescription: String,
		OrderSeriesId: 0,
		PersonInNeed: 0,
		PersonGivenHelp: 0,
		CreatedDate: 0001-01-01,
		LastChangedDate: 0001-01-01,
		OrderDate: 0001-01-01,
		AcceptedHelperCount: 0,
		TotalHelperCount: 0,
		DistanceKm: 0,
		HourNeeded: 0,
		SkillDescription: String,
		EmergencySearch: False,
		SelfPayer: False,
		Clerk: 0,
		DrivingLicense: False,
		VehicleAvailable: False,
		GenderType: 0,
		LiabilityInsurance: False,
		AccidentInsurance: False,
		BusinessTripInsurance: False,
		BillableViaReliefAmount: False,
		CriminalRecordCertificateType: False,
		SocialInsurance: False,
		HelperType: 0,
		CriminalRecordCertificate: False,
		CalculatingWithHelperPrices: False,
		VehicleType: 0,
		Liability: False,
		Accident: False,
		BusinessTravelInsurance: False,
		DependentChildrenCare: False,
		IsDispoCoordinated: False,
		ForServiceProvider: False,
		SkillCatalogTypeId: 0,
		Person: 
		{
			Id: 0,
			AccountId: 0,
			OrganisationId: 0,
			Forename: String,
			Lastname: String,
			Birthday: 0001-01-01,
			Notes: String,
			PersonTyp: 0,
			CareLevel: NoCarelevel,
			CareLevelDate: 0001-01-01,
			PhoneNumber: String,
			EMail: String,
			Mobile: String,
			Gender: 0,
			SearchForTrainedHelper: False,
			Gendertype: male,
			Relationshipstatus: NotAvailable,
			GeographicalFrame: 0,
			Deleted: False,
			PicLink: String,
			BlobPicLink: String,
			Address: 
			{
				Id: 0,
				AccountId: 0,
				PersonId: 0,
				Street: String,
				BuildingNo: String,
				PostCode: String,
				District: String,
				City: String,
				Latitude: 0,
				Longitude: 0,
				AddressSupplement: String
			},
			User: 
			{
				Id: 0,
				AccountId: 0,
				EMail: String,
				Password: String,
				IsAdministrator: False,
				IsSuperAdmin: False,
				PersonId: 0,
				IsClient: False,
				UserVerified: False,
				UserUnlocked: False,
				IsDeleted: False
			},
			FullMonthlyCapacity: False,
			FilterOnLanguages: 
			[
				0
			],
			PersonHelperTyp: EverydayHelper,
			Fax: String,
			PinDesiredHours: 0,
			Salutation: None,
			Title: None,
			AttentivelyBy: Default,
			Iban: String,
			BIC: String,
			AlternativeAccountHolder: String,
			CreditInstitution: String,
			PaymentTypeId: 0,
			SepaMandateReferenceNumber: String,
			ReasonForPayment: False,
			PaymentRecipient: String,
			CreditorIdent: String,
			WantsDementialLecture: False
		},
		IsDeleted: False,
		DeletionReason: String,
		GoingToTheToilet: False,
		FilterOnLanguages: 
		[
			0
		],
		WorkflowStatus: Details
	}
]