Service

GetClientAvailableHelperForOrderSeries

The following routes are available for this service:
GET	/client/AvailableHelperForOrderSeries

**GetClientAvailableHelperForOrderSeries** Parameters:
Name	Parameter	Data Type	Required
Skills	query	List<long>	No
OrderDate	query	DateTime	No
OrderTimes	query	List<ClientOrderTimeApiModel>	No
OrderSeries	query	ClientOrderSeriesResponse	No
FilterOnLanguage	query	List<int>	No
SearchOptions	query	ClientHelperSearchOptionsApiModel	No

**ClientOrderTimeApiModel** Parameters:
Name	Parameter	Data Type	Required
OrderSeriesId	form	long?	No
WeekDayId	form	int	No
AvailableFrom	form	long?	No
AvailableTo	form	long?	No
HourNeeded	form	decimal	No

**ClientOrderSeriesResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AccountId	form	long	No
OrderDateFrom	form	DateTime?	No
OrderDateTill	form	DateTime?	No
FrequencyId	form	int	No
DaysPerWeek	form	int	No
PersonInNeed	form	long	No
PersonGivingHelp	form	long?	No
HourNeeded	form	decimal	No
CreatedDate	form	DateTime?	No
LastChangedDate	form	DateTime?	No
Status	form	OrderStatus	No
StatusId	form	int	No
OrderDescription	form	string	No
InterviewDate	form	DateTime?	No
InterviewNotes	form	string	No
IsDeleted	form	bool	No
DeletionReason	form	string	No
OrdersCreated	form	bool	No
AcceptedHelperCount	form	int	No
TotalHelperCount	form	int	No
Person	form	ClientPersonResponse	No
SkillDescription	form	string	No
EmergencySearch	form	bool	No
SelfPayer	form	bool	No
Clerk	form	long	No
DrivingLicense	form	bool	No
VehicleAvailable	form	bool	No
GenderType	form	int	No
LiabilityInsurance	form	bool	No
AccidentInsurance	form	bool	No
BusinessTripInsurance	form	bool	No
BillableViaReliefAmount	form	bool	No
CriminalRecordCertificateType	form	bool	No
SocialInsurance	form	bool	No
HelperType	form	int	No
CriminalRecordCertificate	form	bool	No
CalculatingWithHelperPrices	form	bool	No
VehicleType	form	int	No
Liability	form	bool	No
Accident	form	bool	No
BusinessTravelInsurance	form	bool	No
DependentChildrenCare	form	bool	No
IsDispoCoordinated	form	bool	No
ForServiceProvider	form	bool	No
SkillCatalogTypeId	form	int	No
GoingToTheToilet	form	bool	No
FilterOnLanguages	form	List<int>	No
WorkflowStatus	form	OrderWorkflowStatus	No
OrderList	form	List<ClientOrderResponse>	No

**ClientPersonResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AccountId	form	long	No
OrganisationId	form	long?	No
Forename	form	string	No
Lastname	form	string	No
Birthday	form	DateTime?	No
Notes	form	string	No
PersonTyp	form	int	No
CareLevel	form	CareLevel	No
CareLevelDate	form	DateTime?	No
PhoneNumber	form	string	No
EMail	form	string	No
Mobile	form	string	No
Gender	form	int	No
SearchForTrainedHelper	form	bool	No
Gendertype	form	Gender	No
Relationshipstatus	form	Relationshipstatus	No
GeographicalFrame	form	int	No
Deleted	form	bool	No
PicLink	form	string	No
BlobPicLink	form	string	No
Address	form	ClientAddressResponse	No
User	form	ClientUserResponse	No
FullMonthlyCapacity	form	bool	No
FilterOnLanguages	form	List<int>	No
PersonHelperTyp	form	PersonHelperType	No
Fax	form	string	No
PinDesiredHours	form	decimal	No
Salutation	form	Salutation	No
Title	form	Title	No
AttentivelyBy	form	AttentivelyBy	No
Iban	form	string	No
BIC	form	string	No
AlternativeAccountHolder	form	string	No
CreditInstitution	form	string	No
PaymentTypeId	form	long	No
SepaMandateReferenceNumber	form	string	No
ReasonForPayment	form	bool	No
PaymentRecipient	form	string	No
CreditorIdent	form	string	No
WantsDementialLecture	form	bool?	No

**ClientAddressResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AccountId	form	long	No
PersonId	form	long	No
Street	form	string	No
BuildingNo	form	string	No
PostCode	form	string	No
District	form	string	No
City	form	string	No
Latitude	form	double	No
Longitude	form	double	No
AddressSupplement	form	string	No

**ClientUserResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AccountId	form	long	No
EMail	form	string	No
Password	form	string	No
IsAdministrator	form	bool	No
IsSuperAdmin	form	bool	No
PersonId	form	long	No
IsClient	form	bool	No
UserVerified	form	bool	No
UserUnlocked	form	bool	No
IsDeleted	form	bool	No

**ClientOrderResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AccountId	form	long	No
Status	form	OrderStatus	No
OrderDescription	form	string	No
OrderSeriesId	form	long?	No
PersonInNeed	form	long	No
PersonGivenHelp	form	long?	No
CreatedDate	form	DateTime?	No
LastChangedDate	form	DateTime?	No
OrderDate	form	DateTime?	No
AcceptedHelperCount	form	int	No
TotalHelperCount	form	int	No
DistanceKm	form	decimal	No
HourNeeded	form	decimal	No
SkillDescription	form	string	No
EmergencySearch	form	bool	No
SelfPayer	form	bool	No
Clerk	form	long	No
DrivingLicense	form	bool	No
VehicleAvailable	form	bool	No
GenderType	form	int	No
LiabilityInsurance	form	bool	No
AccidentInsurance	form	bool	No
BusinessTripInsurance	form	bool	No
BillableViaReliefAmount	form	bool	No
CriminalRecordCertificateType	form	bool	No
SocialInsurance	form	bool	No
HelperType	form	int	No
CriminalRecordCertificate	form	bool	No
CalculatingWithHelperPrices	form	bool	No
VehicleType	form	int	No
Liability	form	bool	No
Accident	form	bool	No
BusinessTravelInsurance	form	bool	No
DependentChildrenCare	form	bool	No
IsDispoCoordinated	form	bool	No
ForServiceProvider	form	bool	No
SkillCatalogTypeId	form	int	No
Person	form	ClientPersonResponse	No
IsDeleted	form	bool	No
DeletionReason	form	string	No
GoingToTheToilet	form	bool	No
FilterOnLanguages	form	List<int>	No
WorkflowStatus	form	OrderWorkflowStatus	No

**ClientHelperSearchOptionsApiModel** Parameters:
Name	Parameter	Data Type	Required
WantsDementialLecture	form	bool	No
BasicAssistance	form	bool	No
QualifiedAssistance	form	bool	No
HomeVisits	form	bool	No
BillableThroughHealthInsurance	form	bool	No
BillableViaIntegrationAssistance	form	bool	No
Chargeable	form	bool	No

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 /client/AvailableHelperForOrderSeries HTTP/1.1 
Host: api.helferportal.de 
Accept: text/jsv

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