Service

<back to all web services

HelperPutPerson

The following routes are available for this service:
PUT/Helper/Person
HelperPutPerson Parameters:
NameParameterData TypeRequiredDescription
IdbodylongNo
SalutationbodyintNo
TitlebodyintNo
ForenamebodystringNo
LastnamebodystringNo
BirthdaybodyDateTime?No
PersonTypbodyintNo
PhoneNumberbodystringNo
EMailbodystringNo
MobilebodystringNo
GenderbodyintNo
GendertypebodyGenderNo
NotesbodystringNo
GeographicalFramebodyintNo
PicLinkbodystringNo
FullMonthlyCapacitybodyboolNo
CompanybodystringNo
HomeVisitsbodyboolNo
OperationAreabodystringNo
IkNumberbodylong?No
OpeningHoursbodystringNo
PersonHelperTypebodyint?No
EverydayHelperIsFullTimebodyintNo
EverydayHelperIsFullTimeTypebodyPersonEverydayHelperTypeNo
FilterOnLanguagesbodyList<int>No
DrivingLicensebodyboolNo
VehicleAvailablebodyboolNo
VehicleTypebodyVehicleTypeNo
VehicleTypeIdbodyintNo
GoingToTheToiletbodyboolNo
BasicAssistancebodyboolNo
QualifiedAssistancebodyboolNo
CriminalRecordCertificatebodyboolNo
ChargeablebodyboolNo
BillableThroughHealthInsurancebodyboolNo
BillableViaReliefAmountbodyboolNo
BillableViaIntegrationAssistancebodyboolNo
NoInterviewRequiredbodyboolNo
InitialInterviewbodyboolNo
CalculationOnPointsbodyboolNo
SmartphonebodyboolNo
GetNewsletterbodyboolNo
DependentChildrenCarebodyboolNo
MeaslesProtectionbodyboolNo
InterestsbodystringNo
WantsDementialLecturebodyboolNo
JobbodystringNo
HoursPerMonthbodyintNo
IbanbodystringNo
BICbodystringNo
AlternativeAccountHolderbodystringNo
CreditInstitutionbodystringNo
PaymentTypeIdbodylongNo
PaymentTypebodyPaymentTypesNo
PersonResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SalutationformintNo
TitleformintNo
ForenameformstringNo
LastnameformstringNo
BirthdayformDateTime?No
CriminalRecordCertificateValidTillformDateTime?No
CertificatedformDateTime?No
NotesformstringNo
PersonTypformintNo
IsHelperformboolNo
CareLevelformCareLevelNo
PhoneNumberformstringNo
EMailformstringNo
MobileformstringNo
GenderformintNo
SearchForTrainedHelperformboolNo
GendertypeformGenderNo
GeographicalFrameformintNo
DeletedformboolNo
PicLinkformstringNo
BlobPicLinkformstringNo
AddressformAddressResponseNo
UserformUserResponseNo
FullMonthlyCapacityformboolNo
FilterOnLanguagesformList<int>No
CompanyformstringNo
HomeVisitsformboolNo
OperationAreaformstringNo
IkNumberformstringNo
OpeningHoursformstringNo
PersonHelperTypformPersonHelperTypeNo
EverydayHelperIsFullTimeformintNo
EverydayHelperIsFullTimeTypeformPersonEverydayHelperTypeNo
DrivingLicenseformboolNo
VehicleAvailableformboolNo
VehicleTypeformVehicleTypeNo
VehicleTypeIdformintNo
GoingToTheToiletformboolNo
BasicAssistanceformboolNo
QualifiedAssistanceformboolNo
CriminalRecordCertificateformboolNo
ChargeableformboolNo
BillableThroughHealthInsuranceformboolNo
BillableViaReliefAmountformboolNo
BillableViaIntegrationAssistanceformboolNo
NoInterviewRequiredformboolNo
InitialInterviewformboolNo
CalculationOnPointsformboolNo
SmartphoneformboolNo
GetNewsletterformboolNo
DependentChildrenCareformboolNo
MeaslesProtectionformboolNo
InterestsformstringNo
JobformstringNo
WantsDementialLectureformboolNo
HoursPerMonthformintNo
IbanformstringNo
BICformstringNo
AlternativeAccountHolderformstringNo
CreditInstitutionformstringNo
OrganisationIdformlong?No
PaymentTypeIdformlongNo
PaymentTypeformPaymentTypesNo
AddressResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PersonIdformlongNo
StreetformstringNo
BuildingNoformstringNo
AddressSupplementformstringNo
PostCodeformstringNo
DistrictformstringNo
CityformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
UserResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EMailformstringNo
PasswordformstringNo
IsAdministratorformboolNo
IsSuperAdminformboolNo
PersonIdformlongNo
UserVerifiedformboolNo
UserUnlockedformboolNo
IsDeletedformboolNo

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.

PUT /Helper/Person HTTP/1.1 
Host: api.helferportal.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Salutation: 0,
	Title: 0,
	Forename: String,
	Lastname: String,
	Birthday: 0001-01-01,
	PersonTyp: 0,
	PhoneNumber: String,
	EMail: String,
	Mobile: String,
	Gender: 0,
	Gendertype: male,
	Notes: String,
	GeographicalFrame: 0,
	PicLink: String,
	FullMonthlyCapacity: False,
	Company: String,
	HomeVisits: False,
	OperationArea: String,
	IkNumber: 0,
	OpeningHours: String,
	PersonHelperType: 0,
	EverydayHelperIsFullTime: 0,
	EverydayHelperIsFullTimeType: Voluntarily,
	FilterOnLanguages: 
	[
		0
	],
	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,
	WantsDementialLecture: False,
	Job: String,
	HoursPerMonth: 0,
	Iban: String,
	BIC: String,
	AlternativeAccountHolder: String,
	CreditInstitution: String,
	PaymentTypeId: 10,
	PaymentType: Invoice
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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
}