| POST | /Register/NewUser/ |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RegisterNewUser | body | RegisterResponse | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | long? | No | |
| SubDomainId | form | long? | No | |
| RegisterPerson | form | RegisterPersonResponse | No | |
| Qualifications | form | List<QualificationResponse> | No | |
| Skills | form | List<long> | No | |
| ExecutionTimes | form | List<PersonAvailabilityResponse> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Salutation | form | int | No | |
| Title | form | int | No | |
| RelationshipState | form | int | No | |
| EmploymentLevel | form | int | No | |
| CurrentJob | form | string | No | |
| HoursPerMonth | form | double | No | |
| HasDriverLicense | form | bool | No | |
| HasCarAvailable | form | bool | No | |
| CurrentVehicleTyp | form | int | No | |
| Person | form | PersonResponse | No | |
| TransactionTyp | form | int | No | |
| IBAN | form | string | No | |
| BIC | form | string | No | |
| InvoiceViaMail | form | bool | No | |
| Fax | form | string | No | |
| MembershipNumber | form | string | No | |
| NewMember | form | bool | No | |
| GetNewsLetter | form | bool? | No | |
| Description | form | string | No | |
| Interests | form | string | No | |
| NoteContactData | form | string | No | |
| NoteHoursPerMonth | form | string | No | |
| BillableViaInsurance | form | bool | No | |
| FullMonthlyCapacity | form | bool | No | |
| GoingToTheToilet | form | bool | No | |
| BillableViaIntegrationAssistance | form | bool | No | |
| Chargable | form | bool | No | |
| QualifiedEveryDayHelper | form | bool | No | |
| PoliceCertificateAvailable | form | bool | No | |
| Languages | form | List<int> | No | |
| Company | form | string | No | |
| HomeVisits | form | bool | No | |
| OperationArea | form | string | No | |
| AttentivelyBy | form | int | No | |
| AttentivelyByType | form | AttentivelyBy | No | |
| IkNumber | form | long? | No | |
| OpeningHours | form | string | No | |
| EverydayHelperIsFullTime | form | int | No | |
| EverydayHelperIsFullTimeType | form | PersonEverydayHelperType | No | |
| AcceptedEngagementTypeId | form | int | No | |
| AcceptedEngagementType | form | EngagementType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Salutation | form | int | No | |
| Title | form | int | No | |
| Forename | form | string | No | |
| Lastname | form | string | No | |
| Birthday | form | DateTime? | No | |
| CriminalRecordCertificateValidTill | form | DateTime? | No | |
| Certificated | form | DateTime? | No | |
| Notes | form | string | No | |
| PersonTyp | form | int | No | |
| IsHelper | form | bool | No | |
| CareLevel | form | CareLevel | No | |
| PhoneNumber | form | string | No | |
| form | string | No | ||
| Mobile | form | string | No | |
| Gender | form | int | No | |
| SearchForTrainedHelper | form | bool | No | |
| Gendertype | form | Gender | No | |
| GeographicalFrame | form | int | No | |
| Deleted | form | bool | No | |
| PicLink | form | string | No | |
| BlobPicLink | form | string | No | |
| Address | form | AddressResponse | No | |
| User | form | UserResponse | No | |
| FullMonthlyCapacity | form | bool | No | |
| FilterOnLanguages | form | List<int> | No | |
| Company | form | string | No | |
| HomeVisits | form | bool | No | |
| OperationArea | form | string | No | |
| IkNumber | form | string | No | |
| OpeningHours | form | string | No | |
| PersonHelperTyp | form | PersonHelperType | No | |
| EverydayHelperIsFullTime | form | int | No | |
| EverydayHelperIsFullTimeType | form | PersonEverydayHelperType | No | |
| DrivingLicense | form | bool | No | |
| VehicleAvailable | form | bool | No | |
| VehicleType | form | VehicleType | No | |
| VehicleTypeId | form | int | No | |
| GoingToTheToilet | form | bool | No | |
| CriminalRecordCertificate | form | bool | No | |
| Chargeable | form | bool | No | |
| BillableThroughHealthInsurance | form | bool | No | |
| BillableViaIntegrationAssistance | form | bool | No | |
| NoInterviewRequired | form | bool | No | |
| InitialInterview | form | bool | No | |
| CalculationOnPoints | form | bool | No | |
| Smartphone | form | bool | No | |
| GetNewsletter | form | bool | No | |
| DependentChildrenCare | form | bool | No | |
| MeaslesProtection | form | bool | No | |
| Interests | form | string | No | |
| Job | form | string | No | |
| WantsDementialLecture | form | bool | No | |
| HoursPerMonth | form | int | No | |
| Iban | form | string | No | |
| BIC | form | string | No | |
| AlternativeAccountHolder | form | string | No | |
| CreditInstitution | form | string | No | |
| PaymentTypeId | form | long | No | |
| PaymentType | form | PaymentTypes | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| PersonId | form | long | No | |
| Street | form | string | No | |
| BuildingNo | form | string | No | |
| AddressSupplement | form | string | No | |
| PostCode | form | string | No | |
| District | form | string | No | |
| City | form | string | No | |
| Latitude | form | double | No | |
| Longitude | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| form | string | No | ||
| Password | form | string | No | |
| IsAdministrator | form | bool | No | |
| IsSuperAdmin | form | bool | No | |
| PersonId | form | long | No | |
| UserVerified | form | bool | No | |
| UserUnlocked | form | bool | No | |
| IsDeleted | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| Name | form | string | No | |
| ParentId | form | long? | 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 | RegisterPersonResponse | No | |
| Qualifications | form | List<QualificationResponse> | No | |
| Skills | form | List<long> | No | |
| ExecutionTimes | form | List<PersonAvailabilityResponse> | 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 /Register/NewUser/ HTTP/1.1
Host: api.helferportal.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
RegisterNewUser:
{
AccountId: 0,
SubDomainId: 0,
RegisterPerson:
{
Salutation: 0,
Title: 0,
RelationshipState: 0,
EmploymentLevel: 0,
CurrentJob: String,
HoursPerMonth: 0,
HasDriverLicense: False,
HasCarAvailable: False,
CurrentVehicleTyp: 0,
Person:
{
Id: 0,
Forename: String,
Lastname: String,
Birthday: 0001-01-01,
Notes: String,
PersonTyp: 0,
CareLevel: NoCarelevel,
PhoneNumber: String,
EMail: String,
Mobile: String,
Gender: 0,
SearchForTrainedHelper: False,
Gendertype: male,
GeographicalFrame: 0,
Deleted: False,
PicLink: String,
BlobPicLink: String,
Address:
{
Id: 0,
PersonId: 0,
Street: String,
BuildingNo: String,
AddressSupplement: String,
PostCode: String,
District: String,
City: String,
Latitude: 0,
Longitude: 0
},
User:
{
Id: 0,
EMail: String,
Password: String,
IsAdministrator: False,
IsSuperAdmin: False,
PersonId: 0,
UserVerified: False,
UserUnlocked: False,
IsDeleted: False
},
FullMonthlyCapacity: False,
FilterOnLanguages:
[
0
],
PersonHelperTyp: EverydayHelper
},
TransactionTyp: 0,
IBAN: String,
BIC: String,
InvoiceViaMail: False,
Fax: String,
MembershipNumber: String,
NewMember: False,
GetNewsLetter: False
},
Qualifications:
[
{
Id: 0,
Name: String,
ParentId: 0
}
],
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,
RelationshipState: 0,
EmploymentLevel: 0,
CurrentJob: String,
HoursPerMonth: 0,
HasDriverLicense: False,
HasCarAvailable: False,
CurrentVehicleTyp: 0,
Person:
{
Id: 0,
Forename: String,
Lastname: String,
Birthday: 0001-01-01,
Notes: String,
PersonTyp: 0,
CareLevel: NoCarelevel,
PhoneNumber: String,
EMail: String,
Mobile: String,
Gender: 0,
SearchForTrainedHelper: False,
Gendertype: male,
GeographicalFrame: 0,
Deleted: False,
PicLink: String,
BlobPicLink: String,
Address:
{
Id: 0,
PersonId: 0,
Street: String,
BuildingNo: String,
AddressSupplement: String,
PostCode: String,
District: String,
City: String,
Latitude: 0,
Longitude: 0
},
User:
{
Id: 0,
EMail: String,
Password: String,
IsAdministrator: False,
IsSuperAdmin: False,
PersonId: 0,
UserVerified: False,
UserUnlocked: False,
IsDeleted: False
},
FullMonthlyCapacity: False,
FilterOnLanguages:
[
0
],
PersonHelperTyp: EverydayHelper
},
TransactionTyp: 0,
IBAN: String,
BIC: String,
InvoiceViaMail: False,
Fax: String,
MembershipNumber: String,
NewMember: False,
GetNewsLetter: False
},
Qualifications:
[
{
Id: 0,
Name: String,
ParentId: 0
}
],
Skills:
[
0
],
ExecutionTimes:
[
{
PersonId: 0,
WeekDayId: 0,
WeekDay: Sunday,
AvailableFrom: 0,
AvailableTo: 0,
HelperAvailability: False
}
]
}