Service

HelperGetOrderByOrderId

The following routes are available for this service:
GET	/Helper/Orders/GetByOrderId/{OrderId}

**HelperGetOrderByOrderId** Parameters:
Name	Parameter	Data Type	Required	Description
OrderId	path	long	No

**OrderResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Status	form	OrderStatus	No
StatusId	form	int	No
PersonInNeed	form	long	No
PersonGivenHelp	form	long?	No
OrderSeriesId	form	long?	No
CreatedDate	form	DateTime?	No
LastChangedDate	form	DateTime?	No
OrderDate	form	DateTime?	No
HourNeeded	form	decimal	No
OrderDescription	form	string	No
InterviewDate	form	DateTime?	No
InterviewNotes	form	string	No
IsDeleted	form	bool	No
DeletionReason	form	string	No
Person	form	PersonResponse	No
SkillDescription	form	string	No
DistanceKm	form	decimal?	No

**PersonResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Salutation	form	int	No
Title	form	int	No
Forename	form	string	No
Lastname	form	string	No
Birthday	form	DateTime?	No
CriminalRecordCertificateValidTill	form	DateTime?	No
Certificated	form	DateTime?	No
Notes	form	string	No
PersonTyp	form	int	No
IsHelper	form	bool	No
CareLevel	form	CareLevel	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
GeographicalFrame	form	int	No
Deleted	form	bool	No
PicLink	form	string	No
BlobPicLink	form	string	No
Address	form	AddressResponse	No
User	form	UserResponse	No
FullMonthlyCapacity	form	bool	No
FilterOnLanguages	form	List<int>	No
Company	form	string	No
HomeVisits	form	bool	No
OperationArea	form	string	No
IkNumber	form	string	No
OpeningHours	form	string	No
PersonHelperTyp	form	PersonHelperType	No
EverydayHelperIsFullTime	form	int	No
EverydayHelperIsFullTimeType	form	PersonEverydayHelperType	No
DrivingLicense	form	bool	No
VehicleAvailable	form	bool	No
VehicleType	form	VehicleType	No
VehicleTypeId	form	int	No
GoingToTheToilet	form	bool	No
CriminalRecordCertificate	form	bool	No
Chargeable	form	bool	No
BillableThroughHealthInsurance	form	bool	No
BillableViaIntegrationAssistance	form	bool	No
NoInterviewRequired	form	bool	No
InitialInterview	form	bool	No
CalculationOnPoints	form	bool	No
Smartphone	form	bool	No
GetNewsletter	form	bool	No
DependentChildrenCare	form	bool	No
MeaslesProtection	form	bool	No
Interests	form	string	No
Job	form	string	No
WantsDementialLecture	form	bool	No
HoursPerMonth	form	int	No
Iban	form	string	No
BIC	form	string	No
AlternativeAccountHolder	form	string	No
CreditInstitution	form	string	No
PaymentTypeId	form	long	No
PaymentType	form	PaymentTypes	No

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

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

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

HTTP + XML

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

GET /Helper/Orders/GetByOrderId/{OrderId} HTTP/1.1 
Host: api.helferportal.de 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel.v2.Routes">
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <DeletionReason>String</DeletionReason>
  <DistanceKm>0</DistanceKm>
  <HourNeeded>0</HourNeeded>
  <Id>0</Id>
  <InterviewDate>0001-01-01T00:00:00</InterviewDate>
  <InterviewNotes>String</InterviewNotes>
  <IsDeleted>false</IsDeleted>
  <LastChangedDate>0001-01-01T00:00:00</LastChangedDate>
  <OrderDate>0001-01-01T00:00:00</OrderDate>
  <OrderDescription>String</OrderDescription>
  <OrderSeriesId>0</OrderSeriesId>
  <Person>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
      <d3p1:AddressSupplement>String</d3p1:AddressSupplement>
      <d3p1:BuildingNo>String</d3p1:BuildingNo>
      <d3p1:City>String</d3p1:City>
      <d3p1:District>String</d3p1:District>
      <d3p1:Id>0</d3p1:Id>
      <d3p1:Latitude>0</d3p1:Latitude>
      <d3p1:Longitude>0</d3p1:Longitude>
      <d3p1:PersonId>0</d3p1:PersonId>
      <d3p1:PostCode>String</d3p1:PostCode>
      <d3p1:Street>String</d3p1:Street>
    </Address>
    <AlternativeAccountHolder>String</AlternativeAccountHolder>
    <BIC>String</BIC>
    <BillableThroughHealthInsurance>false</BillableThroughHealthInsurance>
    <BillableViaIntegrationAssistance>false</BillableViaIntegrationAssistance>
    <Birthday>0001-01-01T00:00:00</Birthday>
    <BlobPicLink>String</BlobPicLink>
    <CalculationOnPoints>false</CalculationOnPoints>
    <CareLevel>NoCarelevel</CareLevel>
    <Certificated>0001-01-01T00:00:00</Certificated>
    <Chargeable>false</Chargeable>
    <Company>String</Company>
    <CreditInstitution>String</CreditInstitution>
    <CriminalRecordCertificate>false</CriminalRecordCertificate>
    <CriminalRecordCertificateValidTill>0001-01-01T00:00:00</CriminalRecordCertificateValidTill>
    <Deleted>false</Deleted>
    <DependentChildrenCare>false</DependentChildrenCare>
    <DrivingLicense>false</DrivingLicense>
    <EMail>String</EMail>
    <EverydayHelperIsFullTime>0</EverydayHelperIsFullTime>
    <EverydayHelperIsFullTimeType>Voluntarily</EverydayHelperIsFullTimeType>
    <FilterOnLanguages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </FilterOnLanguages>
    <Forename>String</Forename>
    <FullMonthlyCapacity>false</FullMonthlyCapacity>
    <Gender>0</Gender>
    <Gendertype>male</Gendertype>
    <GeographicalFrame>0</GeographicalFrame>
    <GetNewsletter>false</GetNewsletter>
    <GoingToTheToilet>false</GoingToTheToilet>
    <HomeVisits>false</HomeVisits>
    <HoursPerMonth>0</HoursPerMonth>
    <Iban>String</Iban>
    <Id>0</Id>
    <IkNumber>String</IkNumber>
    <InitialInterview>false</InitialInterview>
    <Interests>String</Interests>
    <IsHelper>false</IsHelper>
    <Job>String</Job>
    <Lastname>String</Lastname>
    <MeaslesProtection>false</MeaslesProtection>
    <Mobile>String</Mobile>
    <NoInterviewRequired>false</NoInterviewRequired>
    <Notes>String</Notes>
    <OpeningHours>String</OpeningHours>
    <OperationArea>String</OperationArea>
    <PaymentType>Invoice</PaymentType>
    <PaymentTypeId>10</PaymentTypeId>
    <PersonHelperTyp>EverydayHelper</PersonHelperTyp>
    <PersonTyp>0</PersonTyp>
    <PhoneNumber>String</PhoneNumber>
    <PicLink>String</PicLink>
    <Salutation>0</Salutation>
    <SearchForTrainedHelper>false</SearchForTrainedHelper>
    <Smartphone>false</Smartphone>
    <Title>0</Title>
    <User xmlns:d3p1="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
      <d3p1:EMail>String</d3p1:EMail>
      <d3p1:Id>0</d3p1:Id>
      <d3p1:IsAdministrator>false</d3p1:IsAdministrator>
      <d3p1:IsDeleted>false</d3p1:IsDeleted>
      <d3p1:IsSuperAdmin>false</d3p1:IsSuperAdmin>
      <d3p1:Password>String</d3p1:Password>
      <d3p1:PersonId>0</d3p1:PersonId>
      <d3p1:UserUnlocked>false</d3p1:UserUnlocked>
      <d3p1:UserVerified>false</d3p1:UserVerified>
    </User>
    <VehicleAvailable>false</VehicleAvailable>
    <VehicleType>NotAvailable</VehicleType>
    <VehicleTypeId>0</VehicleTypeId>
    <WantsDementialLecture>false</WantsDementialLecture>
  </Person>
  <PersonGivenHelp>0</PersonGivenHelp>
  <PersonInNeed>0</PersonInNeed>
  <SkillDescription>String</SkillDescription>
  <Status>None</Status>
  <StatusId>0</StatusId>
</OrderResponse>