| POST | /client/Register/NewUser |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RegisterNewClientUser | body | RegisterClientApiModel | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | long? | No | |
| SubDomainId | form | long? | No | |
| RegisterPerson | form | RegisterClientPersonApiModel | No | |
| Skills | form | List<long> | No | |
| ExecutionTimes | form | List<RegisterClientExecutionTimeApiModel> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Address | form | RegisterClientAddressApiModel | No | |
| User | form | RegisterClientUserApiModel | No | |
| Salutation | form | int | No | |
| Title | form | int | No | |
| Forename | form | string | No | |
| Lastname | form | string | No | |
| Birthday | form | DateTime | No | |
| Description | form | string | No | |
| Gender | form | int | No | |
| form | string | No | ||
| Phone | form | string | No | |
| NoteContactData | form | string | No | |
| Mobile | form | string | No | |
| Fax | form | string | No | |
| FilterOnLanguages | form | List<int> | No | |
| HoursPerMonth | form | double | No | |
| NoteHoursPerMonth | form | string | No | |
| MembershipNumber | form | string | No | |
| NewMember | form | bool | No | |
| GetNewsletter | form | bool | No | |
| AlertedType | form | string | No | |
| CurrentHouseholdType | form | string | No | |
| WantSchooledPersonal | form | bool | No | |
| CareLevel | form | int | No | |
| CareLevelDate | form | DateTime? | No | |
| Interests | form | string | No | |
| Iban | form | string | No | |
| BIC | form | string | No | |
| CreditInstitution | form | string | No | |
| SendBillsPerMail | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Street | form | string | No | |
| City | form | string | No | |
| BuildingNo | form | string | No | |
| PostCode | form | string | No | |
| AddressSupplement | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| form | string | No | ||
| Password | form | string | No | |
| AccountId | form | long | No | |
| IsClient | form | bool | No | |
| UILanguage | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PersonId | form | long | No | |
| WeekDayId | form | int | No | |
| WeekDay | form | DayOfWeek | No | |
| AvailableFrom | form | long? | No | |
| AvailableTo | form | long? | No | |
| HelperAvailability | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | long? | No | |
| SubDomainId | form | long? | No | |
| RegisterPerson | form | RegisterClientPersonResponse | No | |
| Skills | form | List<long> | No | |
| ExecutionTimes | form | List<ClientPersonAvailabilityResponse> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Salutation | form | int | No | |
| Title | form | int | No | |
| Forename | form | string | No | |
| Lastname | form | string | No | |
| Birthday | form | DateTime | No | |
| Gendertype | form | int | No | |
| ShortDescription | form | string | No | |
| FilterOnLanguages | form | List<int> | No | |
| HoursPerMonth | form | double | No | |
| AlertedType | form | string | No | |
| NoteHoursPerMonth | form | string | No | |
| CurrentHouseholdType | form | string | No | |
| WantSchooledPersonal | form | bool | No | |
| Carelevel | form | string | No | |
| CarelevelDate | form | DateTime? | No | |
| AddressStreet | form | string | No | |
| AddressBuildingNo | form | string | No | |
| AddressPostCode | form | string | No | |
| AddressCity | form | string | No | |
| AddressSupplement | form | string | No | |
| Phone | form | string | No | |
| Mobile | form | string | No | |
| form | string | No | ||
| Fax | form | string | No | |
| MembershipNumber | form | string | No | |
| NewMember | form | bool | No | |
| GetNewsLetter | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PersonId | form | long? | No | |
| AccountId | form | long | No | |
| WeekDayId | form | int | No | |
| AvailableFrom | form | long? | No | |
| AvailableTo | form | long? | No | |
| HelperAvailability | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}