| POST | /Helper/Orders/distance |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Latitude | body | double | No | |
| Longitude | body | double | No | |
| Address | body | string | No | |
| Radius | body | int | No | |
| FilterOnSkills | body | bool | No | |
| ShowAcceptedOrders | body | bool? | No | |
| ShowDeclinedOrders | body | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LastGivenLat | form | double? | No | |
| LastGivenLng | form | double? | No | |
| LastGivenAddress | form | string | No | |
| OrderList | form | List<OrderResponse> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Status | form | OrderStatus | No | |
| StatusId | form | int | No | |
| PersonInNeed | form | long | No | |
| PersonGivenHelp | form | long? | No | |
| OrderSeriesId | form | long? | No | |
| CreatedDate | form | DateTime? | No | |
| LastChangedDate | form | DateTime? | No | |
| OrderDate | form | DateTime? | No | |
| HourNeeded | form | decimal | No | |
| OrderDescription | form | string | No | |
| InterviewDate | form | DateTime? | No | |
| InterviewNotes | form | string | No | |
| IsDeleted | form | bool | No | |
| DeletionReason | form | string | No | |
| Person | form | PersonResponse | No | |
| SkillDescription | form | string | No | |
| DistanceKm | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Salutation | form | int | No | |
| Title | form | int | No | |
| Forename | form | string | No | |
| Lastname | form | string | No | |
| Birthday | form | DateTime? | No | |
| CriminalRecordCertificateValidTill | form | DateTime? | No | |
| Certificated | form | DateTime? | No | |
| Notes | form | string | No | |
| PersonTyp | form | int | No | |
| IsHelper | form | bool | No | |
| CareLevel | form | CareLevel | No | |
| PhoneNumber | form | string | No | |
| form | string | No | ||
| Mobile | form | string | No | |
| Gender | form | int | No | |
| SearchForTrainedHelper | form | bool | No | |
| Gendertype | form | Gender | No | |
| GeographicalFrame | form | int | No | |
| Deleted | form | bool | No | |
| PicLink | form | string | No | |
| BlobPicLink | form | string | No | |
| Address | form | AddressResponse | No | |
| User | form | UserResponse | No | |
| FullMonthlyCapacity | form | bool | No | |
| FilterOnLanguages | form | List<int> | No | |
| Company | form | string | No | |
| HomeVisits | form | bool | No | |
| OperationArea | form | string | No | |
| IkNumber | form | string | No | |
| OpeningHours | form | string | No | |
| PersonHelperTyp | form | PersonHelperType | No | |
| EverydayHelperIsFullTime | form | int | No | |
| EverydayHelperIsFullTimeType | form | PersonEverydayHelperType | No | |
| DrivingLicense | form | bool | No | |
| VehicleAvailable | form | bool | No | |
| VehicleType | form | VehicleType | No | |
| VehicleTypeId | form | int | No | |
| GoingToTheToilet | form | bool | No | |
| CriminalRecordCertificate | form | bool | No | |
| Chargeable | form | bool | No | |
| BillableThroughHealthInsurance | form | bool | No | |
| BillableViaIntegrationAssistance | form | bool | No | |
| NoInterviewRequired | form | bool | No | |
| InitialInterview | form | bool | No | |
| CalculationOnPoints | form | bool | No | |
| Smartphone | form | bool | No | |
| GetNewsletter | form | bool | No | |
| DependentChildrenCare | form | bool | No | |
| MeaslesProtection | form | bool | No | |
| Interests | form | string | No | |
| Job | form | string | No | |
| WantsDementialLecture | form | bool | No | |
| HoursPerMonth | form | int | No | |
| Iban | form | string | No | |
| BIC | form | string | No | |
| AlternativeAccountHolder | form | string | No | |
| CreditInstitution | form | string | No | |
| PaymentTypeId | form | long | No | |
| PaymentType | form | PaymentTypes | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| PersonId | form | long | No | |
| Street | form | string | No | |
| BuildingNo | form | string | No | |
| AddressSupplement | form | string | No | |
| PostCode | form | string | No | |
| District | form | string | No | |
| City | form | string | No | |
| Latitude | form | double | No | |
| Longitude | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| form | string | No | ||
| Password | form | string | No | |
| IsAdministrator | form | bool | No | |
| IsSuperAdmin | form | bool | No | |
| PersonId | form | long | No | |
| UserVerified | form | bool | No | |
| UserUnlocked | form | bool | No | |
| IsDeleted | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Helper/Orders/distance HTTP/1.1
Host: api.helferportal.de
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Latitude":0,"Longitude":0,"Address":"String","Radius":0,"FilterOnSkills":false,"ShowAcceptedOrders":false,"ShowDeclinedOrders":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"LastGivenLat":0,"LastGivenLng":0,"LastGivenAddress":"String","OrderList":[{"Id":0,"Status":"None","StatusId":0,"PersonInNeed":0,"PersonGivenHelp":0,"OrderSeriesId":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","LastChangedDate":"\/Date(-62135596800000-0000)\/","OrderDate":"\/Date(-62135596800000-0000)\/","HourNeeded":0,"OrderDescription":"String","InterviewDate":"\/Date(-62135596800000-0000)\/","InterviewNotes":"String","IsDeleted":false,"DeletionReason":"String","Person":{"Id":0,"Salutation":0,"Title":0,"Forename":"String","Lastname":"String","Birthday":"\/Date(-62135596800000-0000)\/","CriminalRecordCertificateValidTill":"\/Date(-62135596800000-0000)\/","Certificated":"\/Date(-62135596800000-0000)\/","Notes":"String","PersonTyp":0,"IsHelper":false,"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],"Company":"String","HomeVisits":false,"OperationArea":"String","IkNumber":"String","OpeningHours":"String","PersonHelperTyp":"EverydayHelper","EverydayHelperIsFullTime":0,"EverydayHelperIsFullTimeType":"Voluntarily","DrivingLicense":false,"VehicleAvailable":false,"VehicleType":"NotAvailable","VehicleTypeId":0,"GoingToTheToilet":false,"CriminalRecordCertificate":false,"Chargeable":false,"BillableThroughHealthInsurance":false,"BillableViaIntegrationAssistance":false,"NoInterviewRequired":false,"InitialInterview":false,"CalculationOnPoints":false,"Smartphone":false,"GetNewsletter":false,"DependentChildrenCare":false,"MeaslesProtection":false,"Interests":"String","Job":"String","WantsDementialLecture":false,"HoursPerMonth":0,"Iban":"String","BIC":"String","AlternativeAccountHolder":"String","CreditInstitution":"String","PaymentTypeId":10,"PaymentType":"Invoice"},"SkillDescription":"String","DistanceKm":0}]}