Service

<back to all web services

PostRegisterNewClientUser

The following routes are available for this service:
POST/client/Register/NewUser
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /client/Register/NewUser HTTP/1.1 
Host: api.helferportal.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RegisterNewClientUser: 
	{
		AccountId: 0,
		SubDomainId: 0,
		RegisterPerson: 
		{
			Address: 
			{
				Street: String,
				City: String,
				BuildingNo: String,
				PostCode: String,
				AddressSupplement: String
			},
			User: 
			{
				EMail: String,
				Password: String,
				AccountId: 0,
				IsClient: False,
				UILanguage: 0
			},
			Salutation: 0,
			Title: 0,
			Forename: String,
			Lastname: String,
			Birthday: 0001-01-01,
			Description: String,
			Gender: 0,
			EMail: String,
			Phone: String,
			NoteContactData: String,
			Mobile: String,
			Fax: String,
			FilterOnLanguages: 
			[
				0
			],
			HoursPerMonth: 0,
			NoteHoursPerMonth: String,
			MembershipNumber: String,
			NewMember: False,
			GetNewsletter: False,
			AlertedType: String,
			CurrentHouseholdType: String,
			WantSchooledPersonal: False,
			CareLevel: 0,
			CareLevelDate: 0001-01-01,
			Interests: String,
			Iban: String,
			BIC: String,
			CreditInstitution: String,
			SendBillsPerMail: False
		},
		Skills: 
		[
			0
		],
		ExecutionTimes: 
		[
			{
				PersonId: 0,
				WeekDayId: 0,
				WeekDay: Sunday,
				AvailableFrom: 0,
				AvailableTo: 0,
				HelperAvailability: False
			}
		]
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	AccountId: 0,
	SubDomainId: 0,
	RegisterPerson: 
	{
		Salutation: 0,
		Title: 0,
		Forename: String,
		Lastname: String,
		Birthday: 0001-01-01,
		Gendertype: 0,
		ShortDescription: String,
		FilterOnLanguages: 
		[
			0
		],
		HoursPerMonth: 0,
		AlertedType: String,
		NoteHoursPerMonth: String,
		CurrentHouseholdType: String,
		WantSchooledPersonal: False,
		Carelevel: String,
		CarelevelDate: 0001-01-01,
		AddressStreet: String,
		AddressBuildingNo: String,
		AddressPostCode: String,
		AddressCity: String,
		AddressSupplement: String,
		Phone: String,
		Mobile: String,
		EMail: String,
		Fax: String,
		MembershipNumber: String,
		NewMember: False,
		GetNewsLetter: False
	},
	Skills: 
	[
		0
	],
	ExecutionTimes: 
	[
		{
			PersonId: 0,
			WeekDayId: 0,
			WeekDay: Sunday,
			AvailableFrom: 0,
			AvailableTo: 0,
			HelperAvailability: False
		}
	]
}