Service

<back to all web services

GetClientOrdersByState

The following routes are available for this service:
GET/client/Orders/{status}
GetClientOrdersByState Parameters:
NameParameterData TypeRequiredDescription
StatuspathOrderStatusNo

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/Orders/{status} HTTP/1.1 
Host: api.helferportal.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfClientOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.Order">
  <ClientOrderResponse>
    <AcceptedHelperCount>0</AcceptedHelperCount>
    <Accident>false</Accident>
    <AccidentInsurance>false</AccidentInsurance>
    <AccountId>0</AccountId>
    <BillableViaReliefAmount>false</BillableViaReliefAmount>
    <BusinessTravelInsurance>false</BusinessTravelInsurance>
    <BusinessTripInsurance>false</BusinessTripInsurance>
    <CalculatingWithHelperPrices>false</CalculatingWithHelperPrices>
    <Clerk>0</Clerk>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <CriminalRecordCertificate>false</CriminalRecordCertificate>
    <CriminalRecordCertificateType>false</CriminalRecordCertificateType>
    <DeletionReason>String</DeletionReason>
    <DependentChildrenCare>false</DependentChildrenCare>
    <DistanceKm>0</DistanceKm>
    <DrivingLicense>false</DrivingLicense>
    <EmergencySearch>false</EmergencySearch>
    <FilterOnLanguages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </FilterOnLanguages>
    <ForServiceProvider>false</ForServiceProvider>
    <GenderType>0</GenderType>
    <GoingToTheToilet>false</GoingToTheToilet>
    <HelperType>0</HelperType>
    <HourNeeded>0</HourNeeded>
    <Id>0</Id>
    <IsDeleted>false</IsDeleted>
    <IsDispoCoordinated>false</IsDispoCoordinated>
    <LastChangedDate>0001-01-01T00:00:00</LastChangedDate>
    <Liability>false</Liability>
    <LiabilityInsurance>false</LiabilityInsurance>
    <OrderDate>0001-01-01T00:00:00</OrderDate>
    <OrderDescription>String</OrderDescription>
    <OrderSeriesId>0</OrderSeriesId>
    <Person xmlns:d3p1="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.Person">
      <d3p1:AccountId>0</d3p1:AccountId>
      <d3p1:Address>
        <d3p1:AccountId>0</d3p1:AccountId>
        <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>
      </d3p1:Address>
      <d3p1:AlternativeAccountHolder>String</d3p1:AlternativeAccountHolder>
      <d3p1:AttentivelyBy>Default</d3p1:AttentivelyBy>
      <d3p1:BIC>String</d3p1:BIC>
      <d3p1:Birthday>0001-01-01T00:00:00</d3p1:Birthday>
      <d3p1:BlobPicLink>String</d3p1:BlobPicLink>
      <d3p1:CareLevel>NoCarelevel</d3p1:CareLevel>
      <d3p1:CareLevelDate>0001-01-01T00:00:00</d3p1:CareLevelDate>
      <d3p1:CreditInstitution>String</d3p1:CreditInstitution>
      <d3p1:CreditorIdent>String</d3p1:CreditorIdent>
      <d3p1:Deleted>false</d3p1:Deleted>
      <d3p1:EMail>String</d3p1:EMail>
      <d3p1:Fax>String</d3p1:Fax>
      <d3p1:FilterOnLanguages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d3p1:FilterOnLanguages>
      <d3p1:Forename>String</d3p1:Forename>
      <d3p1:FullMonthlyCapacity>false</d3p1:FullMonthlyCapacity>
      <d3p1:Gender>0</d3p1:Gender>
      <d3p1:Gendertype>male</d3p1:Gendertype>
      <d3p1:GeographicalFrame>0</d3p1:GeographicalFrame>
      <d3p1:Iban>String</d3p1:Iban>
      <d3p1:Id>0</d3p1:Id>
      <d3p1:Lastname>String</d3p1:Lastname>
      <d3p1:Mobile>String</d3p1:Mobile>
      <d3p1:Notes>String</d3p1:Notes>
      <d3p1:OrganisationId>0</d3p1:OrganisationId>
      <d3p1:PaymentRecipient>String</d3p1:PaymentRecipient>
      <d3p1:PaymentTypeId>0</d3p1:PaymentTypeId>
      <d3p1:PersonHelperTyp>EverydayHelper</d3p1:PersonHelperTyp>
      <d3p1:PersonTyp>0</d3p1:PersonTyp>
      <d3p1:PhoneNumber>String</d3p1:PhoneNumber>
      <d3p1:PicLink>String</d3p1:PicLink>
      <d3p1:PinDesiredHours>0</d3p1:PinDesiredHours>
      <d3p1:ReasonForPayment>false</d3p1:ReasonForPayment>
      <d3p1:Relationshipstatus>NotAvailable</d3p1:Relationshipstatus>
      <d3p1:Salutation>None</d3p1:Salutation>
      <d3p1:SearchForTrainedHelper>false</d3p1:SearchForTrainedHelper>
      <d3p1:SepaMandateReferenceNumber>String</d3p1:SepaMandateReferenceNumber>
      <d3p1:Title>None</d3p1:Title>
      <d3p1:User xmlns:d4p1="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.User">
        <d4p1:AccountId>0</d4p1:AccountId>
        <d4p1:EMail>String</d4p1:EMail>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:IsAdministrator>false</d4p1:IsAdministrator>
        <d4p1:IsClient>false</d4p1:IsClient>
        <d4p1:IsDeleted>false</d4p1:IsDeleted>
        <d4p1:IsSuperAdmin>false</d4p1:IsSuperAdmin>
        <d4p1:Password>String</d4p1:Password>
        <d4p1:PersonId>0</d4p1:PersonId>
        <d4p1:UserUnlocked>false</d4p1:UserUnlocked>
        <d4p1:UserVerified>false</d4p1:UserVerified>
      </d3p1:User>
      <d3p1:WantsDementialLecture>false</d3p1:WantsDementialLecture>
    </Person>
    <PersonGivenHelp>0</PersonGivenHelp>
    <PersonInNeed>0</PersonInNeed>
    <SelfPayer>false</SelfPayer>
    <SkillCatalogTypeId>0</SkillCatalogTypeId>
    <SkillDescription>String</SkillDescription>
    <SocialInsurance>false</SocialInsurance>
    <Status>None</Status>
    <TotalHelperCount>0</TotalHelperCount>
    <VehicleAvailable>false</VehicleAvailable>
    <VehicleType>0</VehicleType>
    <WorkflowStatus>Details</WorkflowStatus>
  </ClientOrderResponse>
</ArrayOfClientOrderResponse>