Service

HelperGetOrderSeriesByState

The following routes are available for this service:
GET	/Helper/OrderSeries/{status}

**HelperGetOrderSeriesByState** Parameters:
Name	Parameter	Data Type	Required	Description
Status	path	OrderStatus	No
LoadAssignedOrders	query	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 /Helper/OrderSeries/{status} HTTP/1.1 
Host: api.helferportal.de 
Accept: application/xml

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

<ArrayOfOrderSeriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel.v2.Routes">
  <OrderSeriesResponse>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <Days>Monday</Days>
    <DaysPerWeek>0</DaysPerWeek>
    <DeletionReason>String</DeletionReason>
    <DistanceKm>0</DistanceKm>
    <FrequencyId>0</FrequencyId>
    <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>
    <OrderDateFrom>0001-01-01T00:00:00</OrderDateFrom>
    <OrderDateTill>0001-01-01T00:00:00</OrderDateTill>
    <OrderDescription>String</OrderDescription>
    <OrderList>
      <OrderResponse>
        <CreatedDate>0001-01-01T00:00:00</CreatedDate>
        <DeletionReason>String</DeletionReason>
        <DistanceKm>0</DistanceKm>
        <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 xmlns:d6p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
            <d6p1:AddressSupplement>String</d6p1:AddressSupplement>
            <d6p1:BuildingNo>String</d6p1:BuildingNo>
            <d6p1:City>String</d6p1:City>
            <d6p1:District>String</d6p1:District>
            <d6p1:Id>0</d6p1:Id>
            <d6p1:Latitude>0</d6p1:Latitude>
            <d6p1:Longitude>0</d6p1:Longitude>
            <d6p1:PersonId>0</d6p1:PersonId>
            <d6p1:PostCode>String</d6p1:PostCode>
            <d6p1:Street>String</d6p1: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:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1: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:d6p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
            <d6p1:EMail>String</d6p1:EMail>
            <d6p1:Id>0</d6p1:Id>
            <d6p1:IsAdministrator>false</d6p1:IsAdministrator>
            <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>
          </User>
          <VehicleAvailable>false</VehicleAvailable>
          <VehicleType>NotAvailable</VehicleType>
          <VehicleTypeId>0</VehicleTypeId>
          <WantsDementialLecture>false</WantsDementialLecture>
        </Person>
        <PersonGivenHelp>0</PersonGivenHelp>
        <PersonInNeed>0</PersonInNeed>
        <SkillDescription>String</SkillDescription>
        <Status>None</Status>
        <StatusId>0</StatusId>
      </OrderResponse>
    </OrderList>
    <OrdersCreated>false</OrdersCreated>
    <Person>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
        <d4p1:AddressSupplement>String</d4p1:AddressSupplement>
        <d4p1:BuildingNo>String</d4p1:BuildingNo>
        <d4p1:City>String</d4p1:City>
        <d4p1:District>String</d4p1:District>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
        <d4p1:PersonId>0</d4p1:PersonId>
        <d4p1:PostCode>String</d4p1:PostCode>
        <d4p1:Street>String</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1: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:d4p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
        <d4p1:EMail>String</d4p1:EMail>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:IsAdministrator>false</d4p1:IsAdministrator>
        <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>
      </User>
      <VehicleAvailable>false</VehicleAvailable>
      <VehicleType>NotAvailable</VehicleType>
      <VehicleTypeId>0</VehicleTypeId>
      <WantsDementialLecture>false</WantsDementialLecture>
    </Person>
    <PersonGivingHelp>0</PersonGivingHelp>
    <PersonInNeed>0</PersonInNeed>
    <SkillDescription>String</SkillDescription>
    <Status>None</Status>
    <StatusId>0</StatusId>
  </OrderSeriesResponse>
</ArrayOfOrderSeriesResponse>