Service

<back to all web services

GetClientPersonsForHelper

The following routes are available for this service:
GET/client/GetClientPersonsForUser/{UserPersonId}
GetClientPersonsForHelper Parameters:
NameParameterData TypeRequiredDescription
UserPersonIdpathlongNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /client/GetClientPersonsForUser/{UserPersonId} HTTP/1.1 
Host: api.helferportal.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfClientPersonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.Person">
  <ClientPersonResponse>
    <AccountId>0</AccountId>
    <Address>
      <AccountId>0</AccountId>
      <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>
    <AlternativeAccountHolder>String</AlternativeAccountHolder>
    <AttentivelyBy>Default</AttentivelyBy>
    <BIC>String</BIC>
    <Birthday>0001-01-01T00:00:00</Birthday>
    <BlobPicLink>String</BlobPicLink>
    <CareLevel>NoCarelevel</CareLevel>
    <CareLevelDate>0001-01-01T00:00:00</CareLevelDate>
    <CreditInstitution>String</CreditInstitution>
    <CreditorIdent>String</CreditorIdent>
    <Deleted>false</Deleted>
    <EMail>String</EMail>
    <Fax>String</Fax>
    <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>
    <Iban>String</Iban>
    <Id>0</Id>
    <Lastname>String</Lastname>
    <Mobile>String</Mobile>
    <Notes>String</Notes>
    <OrganisationId>0</OrganisationId>
    <PaymentRecipient>String</PaymentRecipient>
    <PaymentTypeId>0</PaymentTypeId>
    <PersonHelperTyp>EverydayHelper</PersonHelperTyp>
    <PersonTyp>0</PersonTyp>
    <PhoneNumber>String</PhoneNumber>
    <PicLink>String</PicLink>
    <PinDesiredHours>0</PinDesiredHours>
    <ReasonForPayment>false</ReasonForPayment>
    <Relationshipstatus>NotAvailable</Relationshipstatus>
    <Salutation>None</Salutation>
    <SearchForTrainedHelper>false</SearchForTrainedHelper>
    <SepaMandateReferenceNumber>String</SepaMandateReferenceNumber>
    <Title>None</Title>
    <User xmlns:d3p1="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.User">
      <d3p1:AccountId>0</d3p1:AccountId>
      <d3p1:EMail>String</d3p1:EMail>
      <d3p1:Id>0</d3p1:Id>
      <d3p1:IsAdministrator>false</d3p1:IsAdministrator>
      <d3p1:IsClient>false</d3p1:IsClient>
      <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>
    <WantsDementialLecture>false</WantsDementialLecture>
  </ClientPersonResponse>
</ArrayOfClientPersonResponse>