Service

<back to all web services

HelperGetOpenOrderSeriesByDistance

HelperGetOpenOrderSeriesByDistance Parameters:
NameParameterData TypeRequiredDescription
LatitudebodydoubleNo
LongitudebodydoubleNo
AddressbodystringNo
RadiusbodyintNo
FilterOnSkillsbodyboolNo
ShowAcceptedOrdersbodybool?No
ShowDeclinedOrdersbodybool?No
MapOrderSeriesResponse Parameters:
NameParameterData TypeRequiredDescription
LastGivenLatformdouble?No
LastGivenLngformdouble?No
LastGivenAddressformstringNo
OrderSeriesListformList<OrderSeriesResponse>No
OrderSeriesResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
OrderDateFromformDateTime?No
OrderDateTillformDateTime?No
FrequencyIdformintNo
DaysformWeekdaysNo
PersonInNeedformlongNo
PersonGivingHelpformlong?No
HourNeededformdecimalNo
CreatedDateformDateTime?No
LastChangedDateformDateTime?No
StatusformOrderStatusNo
StatusIdformintNo
OrderDescriptionformstringNo
InterviewDateformDateTime?No
InterviewNotesformstringNo
IsDeletedformboolNo
DeletionReasonformstringNo
OrdersCreatedformboolNo
PersonformPersonResponseNo
DaysPerWeekformintNo
DistanceKmformdecimalNo
SkillDescriptionformstringNo
OrderListformList<OrderResponse>No
PersonResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SalutationformintNo
TitleformintNo
ForenameformstringNo
LastnameformstringNo
BirthdayformDateTime?No
CriminalRecordCertificateValidTillformDateTime?No
CertificatedformDateTime?No
NotesformstringNo
PersonTypformintNo
IsHelperformboolNo
CareLevelformCareLevelNo
PhoneNumberformstringNo
EMailformstringNo
MobileformstringNo
GenderformintNo
SearchForTrainedHelperformboolNo
GendertypeformGenderNo
GeographicalFrameformintNo
DeletedformboolNo
PicLinkformstringNo
BlobPicLinkformstringNo
AddressformAddressResponseNo
UserformUserResponseNo
FullMonthlyCapacityformboolNo
FilterOnLanguagesformList<int>No
CompanyformstringNo
HomeVisitsformboolNo
OperationAreaformstringNo
IkNumberformstringNo
OpeningHoursformstringNo
PersonHelperTypformPersonHelperTypeNo
EverydayHelperIsFullTimeformintNo
EverydayHelperIsFullTimeTypeformPersonEverydayHelperTypeNo
DrivingLicenseformboolNo
VehicleAvailableformboolNo
VehicleTypeformVehicleTypeNo
VehicleTypeIdformintNo
GoingToTheToiletformboolNo
CriminalRecordCertificateformboolNo
ChargeableformboolNo
BillableThroughHealthInsuranceformboolNo
BillableViaIntegrationAssistanceformboolNo
NoInterviewRequiredformboolNo
InitialInterviewformboolNo
CalculationOnPointsformboolNo
SmartphoneformboolNo
GetNewsletterformboolNo
DependentChildrenCareformboolNo
MeaslesProtectionformboolNo
InterestsformstringNo
JobformstringNo
WantsDementialLectureformboolNo
HoursPerMonthformintNo
IbanformstringNo
BICformstringNo
AlternativeAccountHolderformstringNo
CreditInstitutionformstringNo
PaymentTypeIdformlongNo
PaymentTypeformPaymentTypesNo
AddressResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PersonIdformlongNo
StreetformstringNo
BuildingNoformstringNo
AddressSupplementformstringNo
PostCodeformstringNo
DistrictformstringNo
CityformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
UserResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EMailformstringNo
PasswordformstringNo
IsAdministratorformboolNo
IsSuperAdminformboolNo
PersonIdformlongNo
UserVerifiedformboolNo
UserUnlockedformboolNo
IsDeletedformboolNo
OrderResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
StatusformOrderStatusNo
StatusIdformintNo
PersonInNeedformlongNo
PersonGivenHelpformlong?No
OrderSeriesIdformlong?No
CreatedDateformDateTime?No
LastChangedDateformDateTime?No
OrderDateformDateTime?No
HourNeededformdecimalNo
OrderDescriptionformstringNo
InterviewDateformDateTime?No
InterviewNotesformstringNo
IsDeletedformboolNo
DeletionReasonformstringNo
PersonformPersonResponseNo
SkillDescriptionformstringNo
DistanceKmformdecimal?No

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

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: api.helferportal.de 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: HelperGetOpenOrderSeriesByDistance

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<HelperGetOpenOrderSeriesByDistance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel.v2.Routes">
  <Address>String</Address>
  <FilterOnSkills>false</FilterOnSkills>
  <Latitude>0</Latitude>
  <Longitude>0</Longitude>
  <Radius>0</Radius>
  <ShowAcceptedOrders>false</ShowAcceptedOrders>
  <ShowDeclinedOrders>false</ShowDeclinedOrders>
</HelperGetOpenOrderSeriesByDistance>

    </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<MapOrderSeriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel.v2.Routes">
  <LastGivenAddress>String</LastGivenAddress>
  <LastGivenLat>0</LastGivenLat>
  <LastGivenLng>0</LastGivenLng>
  <OrderSeriesList>
    <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:d7p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
              <d7p1:AddressSupplement>String</d7p1:AddressSupplement>
              <d7p1:BuildingNo>String</d7p1:BuildingNo>
              <d7p1:City>String</d7p1:City>
              <d7p1:District>String</d7p1:District>
              <d7p1:Id>0</d7p1:Id>
              <d7p1:Latitude>0</d7p1:Latitude>
              <d7p1:Longitude>0</d7p1:Longitude>
              <d7p1:PersonId>0</d7p1:PersonId>
              <d7p1:PostCode>String</d7p1:PostCode>
              <d7p1:Street>String</d7p1: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:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1: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:d7p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
              <d7p1:EMail>String</d7p1:EMail>
              <d7p1:Id>0</d7p1:Id>
              <d7p1:IsAdministrator>false</d7p1:IsAdministrator>
              <d7p1:IsDeleted>false</d7p1:IsDeleted>
              <d7p1:IsSuperAdmin>false</d7p1:IsSuperAdmin>
              <d7p1:Password>String</d7p1:Password>
              <d7p1:PersonId>0</d7p1:PersonId>
              <d7p1:UserUnlocked>false</d7p1:UserUnlocked>
              <d7p1:UserVerified>false</d7p1: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:d5p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
          <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>
        </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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1: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:d5p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
          <d5p1:EMail>String</d5p1:EMail>
          <d5p1:Id>0</d5p1:Id>
          <d5p1:IsAdministrator>false</d5p1:IsAdministrator>
          <d5p1:IsDeleted>false</d5p1:IsDeleted>
          <d5p1:IsSuperAdmin>false</d5p1:IsSuperAdmin>
          <d5p1:Password>String</d5p1:Password>
          <d5p1:PersonId>0</d5p1:PersonId>
          <d5p1:UserUnlocked>false</d5p1:UserUnlocked>
          <d5p1:UserVerified>false</d5p1: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>
  </OrderSeriesList>
</MapOrderSeriesResponse>

    </soap:Body>
</soap:Envelope>