HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /Helper/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,
Salutation: 0,
Title: 0,
Forename: String,
Lastname: String,
Birthday: 0001-01-01,
CriminalRecordCertificateValidTill: 0001-01-01,
Certificated: 0001-01-01,
Notes: String,
PersonTyp: 0,
IsHelper: False,
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
],
Company: String,
HomeVisits: False,
OperationArea: String,
IkNumber: String,
OpeningHours: String,
PersonHelperTyp: EverydayHelper,
EverydayHelperIsFullTime: 0,
EverydayHelperIsFullTimeType: Voluntarily,
DrivingLicense: False,
VehicleAvailable: False,
VehicleType: NotAvailable,
VehicleTypeId: 0,
GoingToTheToilet: False,
BasicAssistance: False,
QualifiedAssistance: False,
CriminalRecordCertificate: False,
Chargeable: False,
BillableThroughHealthInsurance: False,
BillableViaReliefAmount: False,
BillableViaIntegrationAssistance: False,
NoInterviewRequired: False,
InitialInterview: False,
CalculationOnPoints: False,
Smartphone: False,
GetNewsletter: False,
DependentChildrenCare: False,
MeaslesProtection: False,
Interests: String,
Job: String,
WantsDementialLecture: False,
HoursPerMonth: 0,
Iban: String,
BIC: String,
AlternativeAccountHolder: String,
CreditInstitution: String,
OrganisationId: 0,
PaymentTypeId: 10,
PaymentType: Invoice
},
TransactionTyp: 0,
IBAN: String,
BIC: String,
InvoiceViaMail: False,
Fax: String,
MembershipNumber: String,
NewMember: False,
GetNewsLetter: False,
Description: String,
Interests: String,
NoteContactData: String,
NoteHoursPerMonth: String,
BasicAssistance: False,
QualifiedAssistance: False,
BillableViaInsurance: False,
BillableViaReliefAmount: False,
FullMonthlyCapacity: False,
GoingToTheToilet: False,
BillableViaIntegrationAssistance: False,
Chargable: False,
QualifiedEveryDayHelper: False,
PoliceCertificateAvailable: False,
Languages:
[
0
],
Company: String,
HomeVisits: False,
OperationArea: String,
AttentivelyBy: 0,
AttentivelyByType: Default,
IkNumber: 0,
OpeningHours: String,
EverydayHelperIsFullTime: 0,
EverydayHelperIsFullTimeType: Voluntarily,
AcceptedEngagementTypeId: 1,
AcceptedEngagementType: 1
},
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,
Salutation: 0,
Title: 0,
Forename: String,
Lastname: String,
Birthday: 0001-01-01,
CriminalRecordCertificateValidTill: 0001-01-01,
Certificated: 0001-01-01,
Notes: String,
PersonTyp: 0,
IsHelper: False,
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
],
Company: String,
HomeVisits: False,
OperationArea: String,
IkNumber: String,
OpeningHours: String,
PersonHelperTyp: EverydayHelper,
EverydayHelperIsFullTime: 0,
EverydayHelperIsFullTimeType: Voluntarily,
DrivingLicense: False,
VehicleAvailable: False,
VehicleType: NotAvailable,
VehicleTypeId: 0,
GoingToTheToilet: False,
BasicAssistance: False,
QualifiedAssistance: False,
CriminalRecordCertificate: False,
Chargeable: False,
BillableThroughHealthInsurance: False,
BillableViaReliefAmount: False,
BillableViaIntegrationAssistance: False,
NoInterviewRequired: False,
InitialInterview: False,
CalculationOnPoints: False,
Smartphone: False,
GetNewsletter: False,
DependentChildrenCare: False,
MeaslesProtection: False,
Interests: String,
Job: String,
WantsDementialLecture: False,
HoursPerMonth: 0,
Iban: String,
BIC: String,
AlternativeAccountHolder: String,
CreditInstitution: String,
OrganisationId: 0,
PaymentTypeId: 10,
PaymentType: Invoice
},
TransactionTyp: 0,
IBAN: String,
BIC: String,
InvoiceViaMail: False,
Fax: String,
MembershipNumber: String,
NewMember: False,
GetNewsLetter: False,
Description: String,
Interests: String,
NoteContactData: String,
NoteHoursPerMonth: String,
BasicAssistance: False,
QualifiedAssistance: False,
BillableViaInsurance: False,
BillableViaReliefAmount: False,
FullMonthlyCapacity: False,
GoingToTheToilet: False,
BillableViaIntegrationAssistance: False,
Chargable: False,
QualifiedEveryDayHelper: False,
PoliceCertificateAvailable: False,
Languages:
[
0
],
Company: String,
HomeVisits: False,
OperationArea: String,
AttentivelyBy: 0,
AttentivelyByType: Default,
IkNumber: 0,
OpeningHours: String,
EverydayHelperIsFullTime: 0,
EverydayHelperIsFullTimeType: Voluntarily,
AcceptedEngagementTypeId: 1,
AcceptedEngagementType: 1
},
Qualifications:
[
{
Id: 0,
Name: String,
ParentId: 0
}
],
Skills:
[
0
],
ExecutionTimes:
[
{
PersonId: 0,
WeekDayId: 0,
WeekDay: Sunday,
AvailableFrom: 0,
AvailableTo: 0,
HelperAvailability: False
}
]
}