| GET | /Helper/GetPersonsForUser |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserPersonId | query | long | 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 /Helper/GetPersonsForUser HTTP/1.1 Host: api.helferportal.de Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfPersonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel.v2.Routes">
<PersonResponse>
<Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
<d3p1:AddressSupplement>String</d3p1:AddressSupplement>
<d3p1:BuildingNo>String</d3p1:BuildingNo>
<d3p1:City>String</d3p1:City>
<d3p1:District>String</d3p1:District>
<d3p1:Id>0</d3p1:Id>
<d3p1:Latitude>0</d3p1:Latitude>
<d3p1:Longitude>0</d3p1:Longitude>
<d3p1:PersonId>0</d3p1:PersonId>
<d3p1:PostCode>String</d3p1:PostCode>
<d3p1:Street>String</d3p1:Street>
</Address>
<AlternativeAccountHolder>String</AlternativeAccountHolder>
<BIC>String</BIC>
<BillableThroughHealthInsurance>false</BillableThroughHealthInsurance>
<BillableViaIntegrationAssistance>false</BillableViaIntegrationAssistance>
<Birthday>0001-01-01T00:00:00</Birthday>
<BlobPicLink>String</BlobPicLink>
<CalculationOnPoints>false</CalculationOnPoints>
<CareLevel>NoCarelevel</CareLevel>
<Certificated>0001-01-01T00:00:00</Certificated>
<Chargeable>false</Chargeable>
<Company>String</Company>
<CreditInstitution>String</CreditInstitution>
<CriminalRecordCertificate>false</CriminalRecordCertificate>
<CriminalRecordCertificateValidTill>0001-01-01T00:00:00</CriminalRecordCertificateValidTill>
<Deleted>false</Deleted>
<DependentChildrenCare>false</DependentChildrenCare>
<DrivingLicense>false</DrivingLicense>
<EMail>String</EMail>
<EverydayHelperIsFullTime>0</EverydayHelperIsFullTime>
<EverydayHelperIsFullTimeType>Voluntarily</EverydayHelperIsFullTimeType>
<FilterOnLanguages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>0</d3p1:int>
</FilterOnLanguages>
<Forename>String</Forename>
<FullMonthlyCapacity>false</FullMonthlyCapacity>
<Gender>0</Gender>
<Gendertype>male</Gendertype>
<GeographicalFrame>0</GeographicalFrame>
<GetNewsletter>false</GetNewsletter>
<GoingToTheToilet>false</GoingToTheToilet>
<HomeVisits>false</HomeVisits>
<HoursPerMonth>0</HoursPerMonth>
<Iban>String</Iban>
<Id>0</Id>
<IkNumber>String</IkNumber>
<InitialInterview>false</InitialInterview>
<Interests>String</Interests>
<IsHelper>false</IsHelper>
<Job>String</Job>
<Lastname>String</Lastname>
<MeaslesProtection>false</MeaslesProtection>
<Mobile>String</Mobile>
<NoInterviewRequired>false</NoInterviewRequired>
<Notes>String</Notes>
<OpeningHours>String</OpeningHours>
<OperationArea>String</OperationArea>
<PaymentType>Invoice</PaymentType>
<PaymentTypeId>10</PaymentTypeId>
<PersonHelperTyp>EverydayHelper</PersonHelperTyp>
<PersonTyp>0</PersonTyp>
<PhoneNumber>String</PhoneNumber>
<PicLink>String</PicLink>
<Salutation>0</Salutation>
<SearchForTrainedHelper>false</SearchForTrainedHelper>
<Smartphone>false</Smartphone>
<Title>0</Title>
<User xmlns:d3p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
<d3p1:EMail>String</d3p1:EMail>
<d3p1:Id>0</d3p1:Id>
<d3p1:IsAdministrator>false</d3p1:IsAdministrator>
<d3p1:IsDeleted>false</d3p1:IsDeleted>
<d3p1:IsSuperAdmin>false</d3p1:IsSuperAdmin>
<d3p1:Password>String</d3p1:Password>
<d3p1:PersonId>0</d3p1:PersonId>
<d3p1:UserUnlocked>false</d3p1:UserUnlocked>
<d3p1:UserVerified>false</d3p1:UserVerified>
</User>
<VehicleAvailable>false</VehicleAvailable>
<VehicleType>NotAvailable</VehicleType>
<VehicleTypeId>0</VehicleTypeId>
<WantsDementialLecture>false</WantsDementialLecture>
</PersonResponse>
</ArrayOfPersonResponse>