Service

<back to all web services

PutOrderReadyForInvoice

The following routes are available for this service:
PUT/Order/ReadyForInvoice
PutOrderReadyForInvoice Parameters:
NameParameterData TypeRequiredDescription
DistanceKmbodydecimalNo
HoursNeededbodydecimalNo
OrderIdbodylongNo
AccomplishedSkillsbodyList<OrderSkillResponse>No
OrderSkillResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
HoursNeededformdecimalNo
OrderIdformlong?No
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

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.

PUT /Order/ReadyForInvoice HTTP/1.1 
Host: api.helferportal.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutOrderReadyForInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HelferPortal.ApiModel">
  <AccomplishedSkills>
    <OrderSkillResponse>
      <HoursNeeded>0</HoursNeeded>
      <Id>0</Id>
      <Name>String</Name>
      <OrderId>0</OrderId>
    </OrderSkillResponse>
  </AccomplishedSkills>
  <DistanceKm>0</DistanceKm>
  <HoursNeeded>0</HoursNeeded>
  <OrderId>0</OrderId>
</PutOrderReadyForInvoice>
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">
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <DeletionReason>String</DeletionReason>
  <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>
      <AddressSupplement>String</AddressSupplement>
      <BuildingNo>String</BuildingNo>
      <City>String</City>
      <District>String</District>
      <Id>0</Id>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <PersonId>0</PersonId>
      <PostCode>String</PostCode>
      <Street>String</Street>
    </Address>
    <Birthday>0001-01-01T00:00:00</Birthday>
    <BlobPicLink>String</BlobPicLink>
    <CareLevel>NoCarelevel</CareLevel>
    <Deleted>false</Deleted>
    <EMail>String</EMail>
    <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>
    <Id>0</Id>
    <Lastname>String</Lastname>
    <Mobile>String</Mobile>
    <Notes>String</Notes>
    <PersonHelperTyp>EverydayHelper</PersonHelperTyp>
    <PersonTyp>0</PersonTyp>
    <PhoneNumber>String</PhoneNumber>
    <PicLink>String</PicLink>
    <SearchForTrainedHelper>false</SearchForTrainedHelper>
    <User>
      <EMail>String</EMail>
      <Id>0</Id>
      <IsAdministrator>false</IsAdministrator>
      <IsDeleted>false</IsDeleted>
      <IsSuperAdmin>false</IsSuperAdmin>
      <Password>String</Password>
      <PersonId>0</PersonId>
      <UserUnlocked>false</UserUnlocked>
      <UserVerified>false</UserVerified>
    </User>
  </Person>
  <PersonGivenHelp>0</PersonGivenHelp>
  <PersonInNeed>0</PersonInNeed>
  <SkillDescription>String</SkillDescription>
  <Status>None</Status>
  <StatusId>0</StatusId>
</OrderResponse>