Service

<back to all web services

HelperGetPersonsForHelper

The following routes are available for this service:
GET/Helper/GetPersonsForUser
HelperGetPersonsForHelper Parameters:
NameParameterData TypeRequiredDescription
UserPersonIdquerylongNo

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.

GET /Helper/GetPersonsForUser HTTP/1.1 
Host: api.helferportal.de 
Accept: text/jsv
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,
		CriminalRecordCertificate: False,
		Chargeable: False,
		BillableThroughHealthInsurance: 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,
		PaymentTypeId: 10,
		PaymentType: Invoice
	}
]