Service

<back to all web services

GetClientAvailableHelperForOrder

The following routes are available for this service:
GET/client/AvailableHelperForOrder
GetClientAvailableHelperForOrder Parameters:
NameParameterData TypeRequiredDescription
SkillsqueryList<long>No
HoursNeededquerydecimalNo
OrderDatequeryDateTimeNo
OrderqueryClientOrderResponseNo
FilterOnLanguagequeryList<int>No
SearchOptionsqueryClientHelperSearchOptionsApiModelNo
ClientOrderResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
StatusformOrderStatusNo
OrderDescriptionformstringNo
OrderSeriesIdformlong?No
PersonInNeedformlongNo
PersonGivenHelpformlong?No
CreatedDateformDateTime?No
LastChangedDateformDateTime?No
OrderDateformDateTime?No
AcceptedHelperCountformintNo
TotalHelperCountformintNo
DistanceKmformdecimalNo
HourNeededformdecimalNo
SkillDescriptionformstringNo
EmergencySearchformboolNo
SelfPayerformboolNo
ClerkformlongNo
DrivingLicenseformboolNo
VehicleAvailableformboolNo
GenderTypeformintNo
LiabilityInsuranceformboolNo
AccidentInsuranceformboolNo
BusinessTripInsuranceformboolNo
BillableViaReliefAmountformboolNo
CriminalRecordCertificateTypeformboolNo
SocialInsuranceformboolNo
HelperTypeformintNo
CriminalRecordCertificateformboolNo
CalculatingWithHelperPricesformboolNo
VehicleTypeformintNo
LiabilityformboolNo
AccidentformboolNo
BusinessTravelInsuranceformboolNo
DependentChildrenCareformboolNo
IsDispoCoordinatedformboolNo
ForServiceProviderformboolNo
SkillCatalogTypeIdformintNo
PersonformClientPersonResponseNo
IsDeletedformboolNo
DeletionReasonformstringNo
GoingToTheToiletformboolNo
FilterOnLanguagesformList<int>No
WorkflowStatusformOrderWorkflowStatusNo
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
ClientHelperSearchOptionsApiModel Parameters:
NameParameterData TypeRequiredDescription
WantsDementialLectureformboolNo
BasicAssistanceformboolNo
QualifiedAssistanceformboolNo
HomeVisitsformboolNo
BillableThroughHealthInsuranceformboolNo
BillableViaIntegrationAssistanceformboolNo
ChargeableformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /client/AvailableHelperForOrder HTTP/1.1 
Host: api.helferportal.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"Id":0,"AccountId":0,"OrganisationId":0,"Forename":"String","Lastname":"String","Birthday":"\/Date(-62135596800000-0000)\/","Notes":"String","PersonTyp":0,"CareLevel":"NoCarelevel","CareLevelDate":"\/Date(-62135596800000-0000)\/","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}]