Service

GetClientOrderSeriesByState

The following routes are available for this service:
GET	/client/OrderSeries/{status}/{LoadPersonInNeed}/{LoadAssignedOrders}

**GetClientOrderSeriesByState** Parameters:
Name	Parameter	Data Type	Required
Status	path	OrderStatus	No
LoadPersonInNeed	path	bool	No
LoadAssignedOrders	path	bool	No

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/OrderSeries/{status}/{LoadPersonInNeed}/{LoadAssignedOrders} HTTP/1.1 
Host: api.helferportal.de 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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