Service

<back to all web services

PostRegisterNewClientUser

PostRegisterNewClientUser Parameters:
NameParameterData TypeRequiredDescription
RegisterNewClientUserbodyRegisterClientApiModelNo
RegisterClientApiModel Parameters:
NameParameterData TypeRequiredDescription
AccountIdformlong?No
SubDomainIdformlong?No
RegisterPersonformRegisterClientPersonApiModelNo
SkillsformList<long>No
ExecutionTimesformList<RegisterClientExecutionTimeApiModel>No
RegisterClientPersonApiModel Parameters:
NameParameterData TypeRequiredDescription
AddressformRegisterClientAddressApiModelNo
UserformRegisterClientUserApiModelNo
SalutationformintNo
TitleformintNo
ForenameformstringNo
LastnameformstringNo
BirthdayformDateTimeNo
DescriptionformstringNo
GenderformintNo
EMailformstringNo
PhoneformstringNo
NoteContactDataformstringNo
MobileformstringNo
FaxformstringNo
FilterOnLanguagesformList<int>No
HoursPerMonthformdoubleNo
NoteHoursPerMonthformstringNo
MembershipNumberformstringNo
NewMemberformboolNo
GetNewsletterformboolNo
AlertedTypeformstringNo
CurrentHouseholdTypeformstringNo
WantSchooledPersonalformboolNo
CareLevelformintNo
CareLevelDateformDateTime?No
InterestsformstringNo
IbanformstringNo
BICformstringNo
CreditInstitutionformstringNo
SendBillsPerMailformbool?No
RegisterClientAddressApiModel Parameters:
NameParameterData TypeRequiredDescription
StreetformstringNo
CityformstringNo
BuildingNoformstringNo
PostCodeformstringNo
AddressSupplementformstringNo
RegisterClientUserApiModel Parameters:
NameParameterData TypeRequiredDescription
EMailformstringNo
PasswordformstringNo
AccountIdformlongNo
IsClientformboolNo
UILanguageformintNo
RegisterClientExecutionTimeApiModel Parameters:
NameParameterData TypeRequiredDescription
PersonIdformlongNo
WeekDayIdformintNo
WeekDayformDayOfWeekNo
AvailableFromformlong?No
AvailableToformlong?No
HelperAvailabilityformboolNo
ClientRegisterResponse Parameters:
NameParameterData TypeRequiredDescription
AccountIdformlong?No
SubDomainIdformlong?No
RegisterPersonformRegisterClientPersonResponseNo
SkillsformList<long>No
ExecutionTimesformList<ClientPersonAvailabilityResponse>No
RegisterClientPersonResponse Parameters:
NameParameterData TypeRequiredDescription
SalutationformintNo
TitleformintNo
ForenameformstringNo
LastnameformstringNo
BirthdayformDateTimeNo
GendertypeformintNo
ShortDescriptionformstringNo
FilterOnLanguagesformList<int>No
HoursPerMonthformdoubleNo
AlertedTypeformstringNo
NoteHoursPerMonthformstringNo
CurrentHouseholdTypeformstringNo
WantSchooledPersonalformboolNo
CarelevelformstringNo
CarelevelDateformDateTime?No
AddressStreetformstringNo
AddressBuildingNoformstringNo
AddressPostCodeformstringNo
AddressCityformstringNo
AddressSupplementformstringNo
PhoneformstringNo
MobileformstringNo
EMailformstringNo
FaxformstringNo
MembershipNumberformstringNo
NewMemberformboolNo
GetNewsLetterformbool?No
ClientPersonAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
PersonIdformlong?No
AccountIdformlongNo
WeekDayIdformintNo
AvailableFromformlong?No
AvailableToformlong?No
HelperAvailabilityformboolNo

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: PostRegisterNewClientUser

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

<PostRegisterNewClientUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Routes">
  <RegisterNewClientUser xmlns:d2p1="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.ApiModels.Register">
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:ExecutionTimes>
      <d2p1:RegisterClientExecutionTimeApiModel>
        <d2p1:AvailableFrom>0</d2p1:AvailableFrom>
        <d2p1:AvailableTo>0</d2p1:AvailableTo>
        <d2p1:HelperAvailability>false</d2p1:HelperAvailability>
        <d2p1:PersonId>0</d2p1:PersonId>
        <d2p1:WeekDay>Sunday</d2p1:WeekDay>
        <d2p1:WeekDayId>0</d2p1:WeekDayId>
      </d2p1:RegisterClientExecutionTimeApiModel>
    </d2p1:ExecutionTimes>
    <d2p1:RegisterPerson>
      <d2p1:Address>
        <d2p1:AddressSupplement>String</d2p1:AddressSupplement>
        <d2p1:BuildingNo>String</d2p1:BuildingNo>
        <d2p1:City>String</d2p1:City>
        <d2p1:PostCode>String</d2p1:PostCode>
        <d2p1:Street>String</d2p1:Street>
      </d2p1:Address>
      <d2p1:AlertedType>String</d2p1:AlertedType>
      <d2p1:BIC>String</d2p1:BIC>
      <d2p1:Birthday>0001-01-01T00:00:00</d2p1:Birthday>
      <d2p1:CareLevel>0</d2p1:CareLevel>
      <d2p1:CareLevelDate>0001-01-01T00:00:00</d2p1:CareLevelDate>
      <d2p1:CreditInstitution>String</d2p1:CreditInstitution>
      <d2p1:CurrentHouseholdType>String</d2p1:CurrentHouseholdType>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EMail>String</d2p1:EMail>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:FilterOnLanguages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:FilterOnLanguages>
      <d2p1:Forename>String</d2p1:Forename>
      <d2p1:Gender>0</d2p1:Gender>
      <d2p1:GetNewsletter>false</d2p1:GetNewsletter>
      <d2p1:HoursPerMonth>0</d2p1:HoursPerMonth>
      <d2p1:Iban>String</d2p1:Iban>
      <d2p1:Interests>String</d2p1:Interests>
      <d2p1:Lastname>String</d2p1:Lastname>
      <d2p1:MembershipNumber>String</d2p1:MembershipNumber>
      <d2p1:Mobile>String</d2p1:Mobile>
      <d2p1:NewMember>false</d2p1:NewMember>
      <d2p1:NoteContactData>String</d2p1:NoteContactData>
      <d2p1:NoteHoursPerMonth>String</d2p1:NoteHoursPerMonth>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:Salutation>0</d2p1:Salutation>
      <d2p1:SendBillsPerMail>false</d2p1:SendBillsPerMail>
      <d2p1:Title>0</d2p1:Title>
      <d2p1:User>
        <d2p1:AccountId>0</d2p1:AccountId>
        <d2p1:EMail>String</d2p1:EMail>
        <d2p1:IsClient>false</d2p1:IsClient>
        <d2p1:Password>String</d2p1:Password>
        <d2p1:UILanguage>0</d2p1:UILanguage>
      </d2p1:User>
      <d2p1:WantSchooledPersonal>false</d2p1:WantSchooledPersonal>
    </d2p1:RegisterPerson>
    <d2p1:Skills xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>0</d3p1:long>
    </d2p1:Skills>
    <d2p1:SubDomainId>0</d2p1:SubDomainId>
  </RegisterNewClientUser>
</PostRegisterNewClientUser>

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

<ClientRegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.Register">
  <AccountId>0</AccountId>
  <ExecutionTimes>
    <ClientPersonAvailabilityResponse>
      <AvailableFrom>0</AvailableFrom>
      <AvailableTo>0</AvailableTo>
      <HelperAvailability>false</HelperAvailability>
      <PersonId>0</PersonId>
      <WeekDay>Sunday</WeekDay>
      <WeekDayId>0</WeekDayId>
    </ClientPersonAvailabilityResponse>
  </ExecutionTimes>
  <RegisterPerson>
    <AddressBuildingNo>String</AddressBuildingNo>
    <AddressCity>String</AddressCity>
    <AddressPostCode>String</AddressPostCode>
    <AddressStreet>String</AddressStreet>
    <AddressSupplement>String</AddressSupplement>
    <AlertedType>String</AlertedType>
    <Birthday>0001-01-01T00:00:00</Birthday>
    <Carelevel>String</Carelevel>
    <CarelevelDate>0001-01-01T00:00:00</CarelevelDate>
    <CurrentHouseholdType>String</CurrentHouseholdType>
    <EMail>String</EMail>
    <Fax>String</Fax>
    <FilterOnLanguages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </FilterOnLanguages>
    <Forename>String</Forename>
    <Gendertype>0</Gendertype>
    <GetNewsLetter>false</GetNewsLetter>
    <HoursPerMonth>0</HoursPerMonth>
    <Lastname>String</Lastname>
    <MembershipNumber>String</MembershipNumber>
    <Mobile>String</Mobile>
    <NewMember>false</NewMember>
    <NoteHoursPerMonth>String</NoteHoursPerMonth>
    <Phone>String</Phone>
    <Salutation>0</Salutation>
    <ShortDescription>String</ShortDescription>
    <Title>0</Title>
    <WantSchooledPersonal>false</WantSchooledPersonal>
  </RegisterPerson>
  <Skills xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </Skills>
  <SubDomainId>0</SubDomainId>
</ClientRegisterResponse>

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