| GET | /Orders/distance |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Latitude | query | double | No | |
| Longitude | query | double | No | |
| Address | query | string | No | |
| Radius | query | int | No | |
| FilterOnSkills | query | bool | No | |
| ShowAcceptedOrders | query | bool? | No | |
| ShowDeclinedOrders | query | 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Orders/distance HTTP/1.1 Host: api.helferportal.de Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<MapOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
<LastGivenAddress>String</LastGivenAddress>
<LastGivenLat>0</LastGivenLat>
<LastGivenLng>0</LastGivenLng>
<OrderList>
<OrderResponse>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<DeletionReason>String</DeletionReason>
<HourNeeded>0</HourNeeded>
<Id>0</Id>
<InterviewDate>0001-01-01T00:00:00</InterviewDate>
<InterviewNotes>String</InterviewNotes>
<IsDeleted>false</IsDeleted>
<LastChangedDate>0001-01-01T00:00:00</LastChangedDate>
<OrderDate>0001-01-01T00:00:00</OrderDate>
<OrderDescription>String</OrderDescription>
<OrderSeriesId>0</OrderSeriesId>
<Person>
<Address>
<AddressSupplement>String</AddressSupplement>
<BuildingNo>String</BuildingNo>
<City>String</City>
<District>String</District>
<Id>0</Id>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<PersonId>0</PersonId>
<PostCode>String</PostCode>
<Street>String</Street>
</Address>
<Birthday>0001-01-01T00:00:00</Birthday>
<BlobPicLink>String</BlobPicLink>
<CareLevel>NoCarelevel</CareLevel>
<Deleted>false</Deleted>
<EMail>String</EMail>
<FilterOnLanguages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</FilterOnLanguages>
<Forename>String</Forename>
<FullMonthlyCapacity>false</FullMonthlyCapacity>
<Gender>0</Gender>
<Gendertype>male</Gendertype>
<GeographicalFrame>0</GeographicalFrame>
<Id>0</Id>
<Lastname>String</Lastname>
<Mobile>String</Mobile>
<Notes>String</Notes>
<PersonHelperTyp>EverydayHelper</PersonHelperTyp>
<PersonTyp>0</PersonTyp>
<PhoneNumber>String</PhoneNumber>
<PicLink>String</PicLink>
<SearchForTrainedHelper>false</SearchForTrainedHelper>
<User>
<EMail>String</EMail>
<Id>0</Id>
<IsAdministrator>false</IsAdministrator>
<IsDeleted>false</IsDeleted>
<IsSuperAdmin>false</IsSuperAdmin>
<Password>String</Password>
<PersonId>0</PersonId>
<UserUnlocked>false</UserUnlocked>
<UserVerified>false</UserVerified>
</User>
</Person>
<PersonGivenHelp>0</PersonGivenHelp>
<PersonInNeed>0</PersonInNeed>
<SkillDescription>String</SkillDescription>
<Status>None</Status>
<StatusId>0</StatusId>
</OrderResponse>
</OrderList>
</MapOrderResponse>