Service

<back to all web services

PostRegisterNewUser

PostRegisterNewUser Parameters:
NameParameterData TypeRequiredDescription
RegisterNewUserbodyRegisterResponseNo
RegisterResponse Parameters:
NameParameterData TypeRequiredDescription
AccountIdformlong?No
SubDomainIdformlong?No
RegisterPersonformRegisterPersonResponseNo
QualificationsformList<QualificationResponse>No
SkillsformList<long>No
ExecutionTimesformList<PersonAvailabilityResponse>No
RegisterPersonResponse Parameters:
NameParameterData TypeRequiredDescription
SalutationformintNo
TitleformintNo
RelationshipStateformintNo
EmploymentLevelformintNo
CurrentJobformstringNo
HoursPerMonthformdoubleNo
HasDriverLicenseformboolNo
HasCarAvailableformboolNo
CurrentVehicleTypformintNo
PersonformPersonResponseNo
TransactionTypformintNo
IBANformstringNo
BICformstringNo
InvoiceViaMailformboolNo
FaxformstringNo
MembershipNumberformstringNo
NewMemberformboolNo
GetNewsLetterformbool?No
DescriptionformstringNo
InterestsformstringNo
NoteContactDataformstringNo
NoteHoursPerMonthformstringNo
BillableViaInsuranceformboolNo
FullMonthlyCapacityformboolNo
GoingToTheToiletformboolNo
BillableViaIntegrationAssistanceformboolNo
ChargableformboolNo
QualifiedEveryDayHelperformboolNo
PoliceCertificateAvailableformboolNo
LanguagesformList<int>No
CompanyformstringNo
HomeVisitsformboolNo
OperationAreaformstringNo
AttentivelyByformintNo
AttentivelyByTypeformAttentivelyByNo
IkNumberformlong?No
OpeningHoursformstringNo
EverydayHelperIsFullTimeformintNo
EverydayHelperIsFullTimeTypeformPersonEverydayHelperTypeNo
AcceptedEngagementTypeIdformintNo
AcceptedEngagementTypeformEngagementTypeNo
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
QualificationResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
ParentIdformlong?No
PersonAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
PersonIdformlongNo
WeekDayIdformintNo
WeekDayformDayOfWeekNo
AvailableFromformlong?No
AvailableToformlong?No
HelperAvailabilityformboolNo
RegisterResponse Parameters:
NameParameterData TypeRequiredDescription
AccountIdformlong?No
SubDomainIdformlong?No
RegisterPersonformRegisterPersonResponseNo
QualificationsformList<QualificationResponse>No
SkillsformList<long>No
ExecutionTimesformList<PersonAvailabilityResponse>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: PostRegisterNewUser

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

<PostRegisterNewUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
  <RegisterNewUser>
    <AccountId>0</AccountId>
    <ExecutionTimes>
      <PersonAvailabilityResponse>
        <AvailableFrom>0</AvailableFrom>
        <AvailableTo>0</AvailableTo>
        <HelperAvailability>false</HelperAvailability>
        <PersonId>0</PersonId>
        <WeekDay>Sunday</WeekDay>
        <WeekDayId>0</WeekDayId>
      </PersonAvailabilityResponse>
    </ExecutionTimes>
    <Qualifications>
      <QualificationResponse>
        <Id>0</Id>
        <Name>String</Name>
        <ParentId>0</ParentId>
      </QualificationResponse>
    </Qualifications>
    <RegisterPerson>
      <BIC>String</BIC>
      <CurrentJob>String</CurrentJob>
      <CurrentVehicleTyp>0</CurrentVehicleTyp>
      <EmploymentLevel>0</EmploymentLevel>
      <Fax>String</Fax>
      <GetNewsLetter>false</GetNewsLetter>
      <HasCarAvailable>false</HasCarAvailable>
      <HasDriverLicense>false</HasDriverLicense>
      <HoursPerMonth>0</HoursPerMonth>
      <IBAN>String</IBAN>
      <InvoiceViaMail>false</InvoiceViaMail>
      <MembershipNumber>String</MembershipNumber>
      <NewMember>false</NewMember>
      <Person>
        <Address>
          <AddressSupplement>String</AddressSupplement>
          <BuildingNo>String</BuildingNo>
          <City>String</City>
          <District>String</District>
          <Id>0</Id>
          <Latitude>0</Latitude>
          <Longitude>0</Longitude>
          <PersonId>0</PersonId>
          <PostCode>String</PostCode>
          <Street>String</Street>
        </Address>
        <Birthday>0001-01-01T00:00:00</Birthday>
        <BlobPicLink>String</BlobPicLink>
        <CareLevel>NoCarelevel</CareLevel>
        <Deleted>false</Deleted>
        <EMail>String</EMail>
        <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>
        <Id>0</Id>
        <Lastname>String</Lastname>
        <Mobile>String</Mobile>
        <Notes>String</Notes>
        <PersonHelperTyp>EverydayHelper</PersonHelperTyp>
        <PersonTyp>0</PersonTyp>
        <PhoneNumber>String</PhoneNumber>
        <PicLink>String</PicLink>
        <SearchForTrainedHelper>false</SearchForTrainedHelper>
        <User>
          <EMail>String</EMail>
          <Id>0</Id>
          <IsAdministrator>false</IsAdministrator>
          <IsDeleted>false</IsDeleted>
          <IsSuperAdmin>false</IsSuperAdmin>
          <Password>String</Password>
          <PersonId>0</PersonId>
          <UserUnlocked>false</UserUnlocked>
          <UserVerified>false</UserVerified>
        </User>
      </Person>
      <RelationshipState>0</RelationshipState>
      <Salutation>0</Salutation>
      <Title>0</Title>
      <TransactionTyp>0</TransactionTyp>
    </RegisterPerson>
    <Skills xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>0</d3p1:long>
    </Skills>
    <SubDomainId>0</SubDomainId>
  </RegisterNewUser>
</PostRegisterNewUser>

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

<RegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
  <AccountId>0</AccountId>
  <ExecutionTimes>
    <PersonAvailabilityResponse>
      <AvailableFrom>0</AvailableFrom>
      <AvailableTo>0</AvailableTo>
      <HelperAvailability>false</HelperAvailability>
      <PersonId>0</PersonId>
      <WeekDay>Sunday</WeekDay>
      <WeekDayId>0</WeekDayId>
    </PersonAvailabilityResponse>
  </ExecutionTimes>
  <Qualifications>
    <QualificationResponse>
      <Id>0</Id>
      <Name>String</Name>
      <ParentId>0</ParentId>
    </QualificationResponse>
  </Qualifications>
  <RegisterPerson>
    <BIC>String</BIC>
    <CurrentJob>String</CurrentJob>
    <CurrentVehicleTyp>0</CurrentVehicleTyp>
    <EmploymentLevel>0</EmploymentLevel>
    <Fax>String</Fax>
    <GetNewsLetter>false</GetNewsLetter>
    <HasCarAvailable>false</HasCarAvailable>
    <HasDriverLicense>false</HasDriverLicense>
    <HoursPerMonth>0</HoursPerMonth>
    <IBAN>String</IBAN>
    <InvoiceViaMail>false</InvoiceViaMail>
    <MembershipNumber>String</MembershipNumber>
    <NewMember>false</NewMember>
    <Person>
      <Address>
        <AddressSupplement>String</AddressSupplement>
        <BuildingNo>String</BuildingNo>
        <City>String</City>
        <District>String</District>
        <Id>0</Id>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
        <PersonId>0</PersonId>
        <PostCode>String</PostCode>
        <Street>String</Street>
      </Address>
      <Birthday>0001-01-01T00:00:00</Birthday>
      <BlobPicLink>String</BlobPicLink>
      <CareLevel>NoCarelevel</CareLevel>
      <Deleted>false</Deleted>
      <EMail>String</EMail>
      <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>
      <Id>0</Id>
      <Lastname>String</Lastname>
      <Mobile>String</Mobile>
      <Notes>String</Notes>
      <PersonHelperTyp>EverydayHelper</PersonHelperTyp>
      <PersonTyp>0</PersonTyp>
      <PhoneNumber>String</PhoneNumber>
      <PicLink>String</PicLink>
      <SearchForTrainedHelper>false</SearchForTrainedHelper>
      <User>
        <EMail>String</EMail>
        <Id>0</Id>
        <IsAdministrator>false</IsAdministrator>
        <IsDeleted>false</IsDeleted>
        <IsSuperAdmin>false</IsSuperAdmin>
        <Password>String</Password>
        <PersonId>0</PersonId>
        <UserUnlocked>false</UserUnlocked>
        <UserVerified>false</UserVerified>
      </User>
    </Person>
    <RelationshipState>0</RelationshipState>
    <Salutation>0</Salutation>
    <Title>0</Title>
    <TransactionTyp>0</TransactionTyp>
  </RegisterPerson>
  <Skills xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Skills>
  <SubDomainId>0</SubDomainId>
</RegisterResponse>

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