Service

<back to all web services

HelperPostNewOrder

HelperPostNewOrder Parameters:
NameParameterData TypeRequiredDescription
DistanceKmbodydecimalNo
HoursNeededbodydecimalNo
OrderbodyOrderResponseNo
AccomplishedSkillsbodyList<OrderSkillResponse>No
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
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
OrderSkillResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
HoursNeededformdecimalNo
OrderIdformlong?No
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: HelperPostNewOrder

<?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>

<HelperPostNewOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel.v2.Routes">
  <AccomplishedSkills xmlns:d2p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
    <d2p1:OrderSkillResponse>
      <d2p1:HoursNeeded>0</d2p1:HoursNeeded>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OrderId>0</d2p1:OrderId>
    </d2p1:OrderSkillResponse>
  </AccomplishedSkills>
  <DistanceKm>0</DistanceKm>
  <HoursNeeded>0</HoursNeeded>
  <Order>
    <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: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>
    <PersonGivenHelp>0</PersonGivenHelp>
    <PersonInNeed>0</PersonInNeed>
    <SkillDescription>String</SkillDescription>
    <Status>None</Status>
    <StatusId>0</StatusId>
  </Order>
</HelperPostNewOrder>

    </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>

<OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel.v2.Routes">
  <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:d3p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
      <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>
    </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: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>
    <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:d3p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
      <d3p1:EMail>String</d3p1:EMail>
      <d3p1:Id>0</d3p1:Id>
      <d3p1:IsAdministrator>false</d3p1:IsAdministrator>
      <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>
    <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>

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