Service

<back to all web services

HelperPostOrderHelper

The following routes are available for this service:
POST/Helper/OrderHelper
HelperPostOrderHelper Parameters:
NameParameterData TypeRequiredDescription
OrderIdbodylong?No
OrderSeriesIdbodylong?No
ReactionbodyReactionTypeNo
OrderHelperResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ReactionformReactionTypeNo
ReactionTimeStampformDateTime?No
NotificationTimeformDateTime?No
OrderIdformlong?No
OrderSeriesIdformlong?No
OrderformOrderResponseNo
OrderSeriesformOrderSeriesResponseNo
OrderResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
StatusformOrderStatusNo
StatusIdformintNo
PersonInNeedformlongNo
PersonGivenHelpformlong?No
OrderSeriesIdformlong?No
CreatedDateformDateTime?No
LastChangedDateformDateTime?No
OrderDateformDateTime?No
HourNeededformdecimalNo
OrderDescriptionformstringNo
InterviewDateformDateTime?No
InterviewNotesformstringNo
IsDeletedformboolNo
DeletionReasonformstringNo
PersonformPersonResponseNo
SkillDescriptionformstringNo
DistanceKmformdecimal?No
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
CriminalRecordCertificateformboolNo
ChargeableformboolNo
BillableThroughHealthInsuranceformboolNo
BillableViaIntegrationAssistanceformboolNo
NoInterviewRequiredformboolNo
InitialInterviewformboolNo
CalculationOnPointsformboolNo
SmartphoneformboolNo
GetNewsletterformboolNo
DependentChildrenCareformboolNo
MeaslesProtectionformboolNo
InterestsformstringNo
JobformstringNo
WantsDementialLectureformboolNo
HoursPerMonthformintNo
IbanformstringNo
BICformstringNo
AlternativeAccountHolderformstringNo
CreditInstitutionformstringNo
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
OrderSeriesResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
OrderDateFromformDateTime?No
OrderDateTillformDateTime?No
FrequencyIdformintNo
DaysformWeekdaysNo
PersonInNeedformlongNo
PersonGivingHelpformlong?No
HourNeededformdecimalNo
CreatedDateformDateTime?No
LastChangedDateformDateTime?No
StatusformOrderStatusNo
StatusIdformintNo
OrderDescriptionformstringNo
InterviewDateformDateTime?No
InterviewNotesformstringNo
IsDeletedformboolNo
DeletionReasonformstringNo
OrdersCreatedformboolNo
PersonformPersonResponseNo
DaysPerWeekformintNo
DistanceKmformdecimalNo
SkillDescriptionformstringNo
OrderListformList<OrderResponse>No

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.

POST /Helper/OrderHelper HTTP/1.1 
Host: api.helferportal.de 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"OrderId":0,"OrderSeriesId":0,"Reaction":"None"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"Reaction":"None","ReactionTimeStamp":"\/Date(-62135596800000-0000)\/","NotificationTime":"\/Date(-62135596800000-0000)\/","OrderId":0,"OrderSeriesId":0,"Order":{"Id":0,"Status":"None","StatusId":0,"PersonInNeed":0,"PersonGivenHelp":0,"OrderSeriesId":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","LastChangedDate":"\/Date(-62135596800000-0000)\/","OrderDate":"\/Date(-62135596800000-0000)\/","HourNeeded":0,"OrderDescription":"String","InterviewDate":"\/Date(-62135596800000-0000)\/","InterviewNotes":"String","IsDeleted":false,"DeletionReason":"String","Person":{"Id":0,"Salutation":0,"Title":0,"Forename":"String","Lastname":"String","Birthday":"\/Date(-62135596800000-0000)\/","CriminalRecordCertificateValidTill":"\/Date(-62135596800000-0000)\/","Certificated":"\/Date(-62135596800000-0000)\/","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"},"SkillDescription":"String","DistanceKm":0},"OrderSeries":{"Id":0,"OrderDateFrom":"\/Date(-62135596800000-0000)\/","OrderDateTill":"\/Date(-62135596800000-0000)\/","FrequencyId":0,"Days":1,"PersonInNeed":0,"PersonGivingHelp":0,"HourNeeded":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","LastChangedDate":"\/Date(-62135596800000-0000)\/","Status":"None","StatusId":0,"OrderDescription":"String","InterviewDate":"\/Date(-62135596800000-0000)\/","InterviewNotes":"String","IsDeleted":false,"DeletionReason":"String","OrdersCreated":false,"Person":{"Id":0,"Salutation":0,"Title":0,"Forename":"String","Lastname":"String","Birthday":"\/Date(-62135596800000-0000)\/","CriminalRecordCertificateValidTill":"\/Date(-62135596800000-0000)\/","Certificated":"\/Date(-62135596800000-0000)\/","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"},"DaysPerWeek":0,"DistanceKm":0,"SkillDescription":"String","OrderList":[{"Id":0,"Status":"None","StatusId":0,"PersonInNeed":0,"PersonGivenHelp":0,"OrderSeriesId":0,"CreatedDate":"\/Date(-62135596800000-0000)\/","LastChangedDate":"\/Date(-62135596800000-0000)\/","OrderDate":"\/Date(-62135596800000-0000)\/","HourNeeded":0,"OrderDescription":"String","InterviewDate":"\/Date(-62135596800000-0000)\/","InterviewNotes":"String","IsDeleted":false,"DeletionReason":"String","Person":{"Id":0,"Salutation":0,"Title":0,"Forename":"String","Lastname":"String","Birthday":"\/Date(-62135596800000-0000)\/","CriminalRecordCertificateValidTill":"\/Date(-62135596800000-0000)\/","Certificated":"\/Date(-62135596800000-0000)\/","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"},"SkillDescription":"String","DistanceKm":0}]}}