Service

<back to all web services

PutClientPerson

The following routes are available for this service:
PUT/client/PutClientPerson
PutClientPerson Parameters:
NameParameterData TypeRequiredDescription
PersonbodyClientPersonApiModelNo
ClientPersonApiModel Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ForenameformstringNo
LastnameformstringNo
BirthdayformDateTime?No
PersonTypformintNo
PhoneNumberformstringNo
EMailformstringNo
MobileformstringNo
GenderformintNo
GendertypeformGenderNo
RelationshipstatusformRelationshipstatusNo
GeographicalFrameformintNo
PicLinkformstringNo
FullMonthlyCapacityformboolNo
FilterOnLanguagesformList<int>No
PersonHelperTypeformPersonHelperTypeNo
FaxformstringNo
NotesformstringNo
CareLevelformCareLevelNo
CareLevelDateformDateTime?No
PinDesiredHoursformdecimalNo
SalutationformSalutationNo
TitleformTitleNo
SearchForTrainedHelperformboolNo
AttentivelyByformAttentivelyByNo
IbanformstringNo
BICformstringNo
AlternativeAccountHolderformstringNo
CreditInstitutionformstringNo
PaymentTypeIdformlongNo
ClientPersonResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
OrganisationIdformlong?No
ForenameformstringNo
LastnameformstringNo
BirthdayformDateTime?No
NotesformstringNo
PersonTypformintNo
CareLevelformCareLevelNo
CareLevelDateformDateTime?No
PhoneNumberformstringNo
EMailformstringNo
MobileformstringNo
GenderformintNo
SearchForTrainedHelperformboolNo
GendertypeformGenderNo
RelationshipstatusformRelationshipstatusNo
GeographicalFrameformintNo
DeletedformboolNo
PicLinkformstringNo
BlobPicLinkformstringNo
AddressformClientAddressResponseNo
UserformClientUserResponseNo
FullMonthlyCapacityformboolNo
FilterOnLanguagesformList<int>No
PersonHelperTypformPersonHelperTypeNo
FaxformstringNo
PinDesiredHoursformdecimalNo
SalutationformSalutationNo
TitleformTitleNo
AttentivelyByformAttentivelyByNo
IbanformstringNo
BICformstringNo
AlternativeAccountHolderformstringNo
CreditInstitutionformstringNo
PaymentTypeIdformlongNo
SepaMandateReferenceNumberformstringNo
ReasonForPaymentformboolNo
PaymentRecipientformstringNo
CreditorIdentformstringNo
WantsDementialLectureformbool?No
ClientAddressResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
PersonIdformlongNo
StreetformstringNo
BuildingNoformstringNo
PostCodeformstringNo
DistrictformstringNo
CityformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
AddressSupplementformstringNo
ClientUserResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
EMailformstringNo
PasswordformstringNo
IsAdministratorformboolNo
IsSuperAdminformboolNo
PersonIdformlongNo
IsClientformboolNo
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 /client/PutClientPerson HTTP/1.1 
Host: api.helferportal.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Person: 
	{
		Id: 0,
		Forename: String,
		Lastname: String,
		Birthday: 0001-01-01,
		PersonTyp: 0,
		PhoneNumber: String,
		EMail: String,
		Mobile: String,
		Gender: 0,
		Gendertype: male,
		Relationshipstatus: NotAvailable,
		GeographicalFrame: 0,
		PicLink: String,
		FullMonthlyCapacity: False,
		FilterOnLanguages: 
		[
			0
		],
		PersonHelperType: EverydayHelper,
		Fax: String,
		Notes: String,
		CareLevel: NoCarelevel,
		CareLevelDate: 0001-01-01,
		PinDesiredHours: 0,
		Salutation: None,
		Title: None,
		SearchForTrainedHelper: False,
		AttentivelyBy: Default,
		Iban: String,
		BIC: String,
		AlternativeAccountHolder: String,
		CreditInstitution: String,
		PaymentTypeId: 0
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	AccountId: 0,
	OrganisationId: 0,
	Forename: String,
	Lastname: String,
	Birthday: 0001-01-01,
	Notes: String,
	PersonTyp: 0,
	CareLevel: NoCarelevel,
	CareLevelDate: 0001-01-01,
	PhoneNumber: String,
	EMail: String,
	Mobile: String,
	Gender: 0,
	SearchForTrainedHelper: False,
	Gendertype: male,
	Relationshipstatus: NotAvailable,
	GeographicalFrame: 0,
	Deleted: False,
	PicLink: String,
	BlobPicLink: String,
	Address: 
	{
		Id: 0,
		AccountId: 0,
		PersonId: 0,
		Street: String,
		BuildingNo: String,
		PostCode: String,
		District: String,
		City: String,
		Latitude: 0,
		Longitude: 0,
		AddressSupplement: String
	},
	User: 
	{
		Id: 0,
		AccountId: 0,
		EMail: String,
		Password: String,
		IsAdministrator: False,
		IsSuperAdmin: False,
		PersonId: 0,
		IsClient: False,
		UserVerified: False,
		UserUnlocked: False,
		IsDeleted: False
	},
	FullMonthlyCapacity: False,
	FilterOnLanguages: 
	[
		0
	],
	PersonHelperTyp: EverydayHelper,
	Fax: String,
	PinDesiredHours: 0,
	Salutation: None,
	Title: None,
	AttentivelyBy: Default,
	Iban: String,
	BIC: String,
	AlternativeAccountHolder: String,
	CreditInstitution: String,
	PaymentTypeId: 0,
	SepaMandateReferenceNumber: String,
	ReasonForPayment: False,
	PaymentRecipient: String,
	CreditorIdent: String,
	WantsDementialLecture: False
}