Service

<back to all web services

GetOrderHelper

The following routes are available for this service:
GET/OrderHelper

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

[
	{
		Id: 0,
		Reaction: None,
		ReactionTimeStamp: 0001-01-01,
		OrderId: 0,
		OrderSeriesId: 0,
		Order: 
		{
			Id: 0,
			Status: None,
			StatusId: 0,
			PersonInNeed: 0,
			PersonGivenHelp: 0,
			OrderSeriesId: 0,
			CreatedDate: 0001-01-01,
			LastChangedDate: 0001-01-01,
			OrderDate: 0001-01-01,
			HourNeeded: 0,
			OrderDescription: String,
			InterviewDate: 0001-01-01,
			InterviewNotes: String,
			IsDeleted: False,
			DeletionReason: String,
			Person: 
			{
				Id: 0,
				Forename: String,
				Lastname: String,
				Birthday: 0001-01-01,
				Notes: String,
				PersonTyp: 0,
				CareLevel: NoCarelevel,
				PhoneNumber: String,
				EMail: String,
				Mobile: String,
				Gender: 0,
				SearchForTrainedHelper: False,
				Gendertype: male,
				GeographicalFrame: 0,
				Deleted: False,
				PicLink: String,
				BlobPicLink: String,
				Address: 
				{
					Id: 0,
					PersonId: 0,
					Street: String,
					BuildingNo: String,
					AddressSupplement: String,
					PostCode: String,
					District: String,
					City: String,
					Latitude: 0,
					Longitude: 0
				},
				User: 
				{
					Id: 0,
					EMail: String,
					Password: String,
					IsAdministrator: False,
					IsSuperAdmin: False,
					PersonId: 0,
					UserVerified: False,
					UserUnlocked: False,
					IsDeleted: False
				},
				FullMonthlyCapacity: False,
				FilterOnLanguages: 
				[
					0
				],
				PersonHelperTyp: EverydayHelper
			},
			SkillDescription: String
		},
		OrderSeries: 
		{
			Id: 0,
			OrderDateFrom: 0001-01-01,
			OrderDateTill: 0001-01-01,
			FrequencyId: 0,
			Days: 1,
			PersonInNeed: 0,
			PersonGivingHelp: 0,
			HourNeeded: 0,
			CreatedDate: 0001-01-01,
			LastChangedDate: 0001-01-01,
			Status: None,
			StatusId: 0,
			OrderDescription: String,
			InterviewDate: 0001-01-01,
			InterviewNotes: String,
			IsDeleted: False,
			DeletionReason: String,
			OrdersCreated: False,
			Person: 
			{
				Id: 0,
				Forename: String,
				Lastname: String,
				Birthday: 0001-01-01,
				Notes: String,
				PersonTyp: 0,
				CareLevel: NoCarelevel,
				PhoneNumber: String,
				EMail: String,
				Mobile: String,
				Gender: 0,
				SearchForTrainedHelper: False,
				Gendertype: male,
				GeographicalFrame: 0,
				Deleted: False,
				PicLink: String,
				BlobPicLink: String,
				Address: 
				{
					Id: 0,
					PersonId: 0,
					Street: String,
					BuildingNo: String,
					AddressSupplement: String,
					PostCode: String,
					District: String,
					City: String,
					Latitude: 0,
					Longitude: 0
				},
				User: 
				{
					Id: 0,
					EMail: String,
					Password: String,
					IsAdministrator: False,
					IsSuperAdmin: False,
					PersonId: 0,
					UserVerified: False,
					UserUnlocked: False,
					IsDeleted: False
				},
				FullMonthlyCapacity: False,
				FilterOnLanguages: 
				[
					0
				],
				PersonHelperTyp: EverydayHelper
			},
			SkillDescription: String,
			OrderList: 
			[
				{
					Id: 0,
					Status: None,
					StatusId: 0,
					PersonInNeed: 0,
					PersonGivenHelp: 0,
					OrderSeriesId: 0,
					CreatedDate: 0001-01-01,
					LastChangedDate: 0001-01-01,
					OrderDate: 0001-01-01,
					HourNeeded: 0,
					OrderDescription: String,
					InterviewDate: 0001-01-01,
					InterviewNotes: String,
					IsDeleted: False,
					DeletionReason: String,
					Person: 
					{
						Id: 0,
						Forename: String,
						Lastname: String,
						Birthday: 0001-01-01,
						Notes: String,
						PersonTyp: 0,
						CareLevel: NoCarelevel,
						PhoneNumber: String,
						EMail: String,
						Mobile: String,
						Gender: 0,
						SearchForTrainedHelper: False,
						Gendertype: male,
						GeographicalFrame: 0,
						Deleted: False,
						PicLink: String,
						BlobPicLink: String,
						Address: 
						{
							Id: 0,
							PersonId: 0,
							Street: String,
							BuildingNo: String,
							AddressSupplement: String,
							PostCode: String,
							District: String,
							City: String,
							Latitude: 0,
							Longitude: 0
						},
						User: 
						{
							Id: 0,
							EMail: String,
							Password: String,
							IsAdministrator: False,
							IsSuperAdmin: False,
							PersonId: 0,
							UserVerified: False,
							UserUnlocked: False,
							IsDeleted: False
						},
						FullMonthlyCapacity: False,
						FilterOnLanguages: 
						[
							0
						],
						PersonHelperTyp: EverydayHelper
					},
					SkillDescription: String
				}
			]
		}
	}
]