Service

<back to all web services

GetOrderSeriesHelperPerson

The following routes are available for this service:
GET/client/GetOrderSeriesHelper/{OrderSeriesId}
GetOrderSeriesHelperPerson Parameters:
NameParameterData TypeRequiredDescription
OrderSeriesIdpathlongNo
ClientOrderHelperResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PersonIdformlongNo
PicLinkformstringNo
PicLinkOrganisationformstringNo
NotificationTimeformDateTime?No
ReactionIdformintNo
ReactionTimeStampformDateTime?No
OrderIdformlong?No
OrderSeriesIdformlong?No
NotificationsCreatedformboolNo
ForeNameformstringNo
LastNameformstringNo
OrganisationIdformlong?No
CompanyformstringNo
AddressformClientAddressResponseNo
OverallRatingformdecimalNo
CriminalRecordCertificateformboolNo
IsSchooledHelperformboolNo
PricePerUnitformdecimalNo
PricesformList<decimal>No
PreferedToPinformboolNo
NotesformstringNo
AvailabilityDeclaredDateformDateTimeNo
TrainingCertificatesformList<ClientPersonDocumentResponse>No
SendSepaViaClientPortalformboolNo
ClientAddressResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
PersonIdformlongNo
StreetformstringNo
BuildingNoformstringNo
PostCodeformstringNo
DistrictformstringNo
CityformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
AddressSupplementformstringNo
ClientPersonDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PersonIdformlongNo
NameformstringNo
DocumentTypeIdformintNo
DocumentOriginformintNo
DateOfIssuanceformDateTime?No
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.

GET /client/GetOrderSeriesHelper/{OrderSeriesId} HTTP/1.1 
Host: api.helferportal.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientOrderHelperResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.Order">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.Person">
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:AddressSupplement>String</d2p1:AddressSupplement>
    <d2p1:BuildingNo>String</d2p1:BuildingNo>
    <d2p1:City>String</d2p1:City>
    <d2p1:District>String</d2p1:District>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Latitude>0</d2p1:Latitude>
    <d2p1:Longitude>0</d2p1:Longitude>
    <d2p1:PersonId>0</d2p1:PersonId>
    <d2p1:PostCode>String</d2p1:PostCode>
    <d2p1:Street>String</d2p1:Street>
  </Address>
  <AvailabilityDeclaredDate>0001-01-01T00:00:00</AvailabilityDeclaredDate>
  <Company>String</Company>
  <CriminalRecordCertificate>false</CriminalRecordCertificate>
  <ForeName>String</ForeName>
  <Id>0</Id>
  <IsSchooledHelper>false</IsSchooledHelper>
  <LastName>String</LastName>
  <Notes>String</Notes>
  <NotificationTime>0001-01-01T00:00:00</NotificationTime>
  <NotificationsCreated>false</NotificationsCreated>
  <OrderId>0</OrderId>
  <OrderSeriesId>0</OrderSeriesId>
  <OrganisationId>0</OrganisationId>
  <OverallRating>0</OverallRating>
  <PersonId>0</PersonId>
  <PicLink>String</PicLink>
  <PicLinkOrganisation>String</PicLinkOrganisation>
  <PreferedToPin>false</PreferedToPin>
  <PricePerUnit>0</PricePerUnit>
  <Prices xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </Prices>
  <ReactionId>0</ReactionId>
  <ReactionTimeStamp>0001-01-01T00:00:00</ReactionTimeStamp>
  <SendSepaViaClientPortal>false</SendSepaViaClientPortal>
  <TrainingCertificates xmlns:d2p1="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.Person">
    <d2p1:ClientPersonDocumentResponse>
      <d2p1:DateOfIssuance>0001-01-01T00:00:00</d2p1:DateOfIssuance>
      <d2p1:DocumentOrigin>0</d2p1:DocumentOrigin>
      <d2p1:DocumentTypeId>0</d2p1:DocumentTypeId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PersonId>0</d2p1:PersonId>
    </d2p1:ClientPersonDocumentResponse>
  </TrainingCertificates>
</ClientOrderHelperResponse>