Service

<back to all web services

PutClientPersonAvailability

The following routes are available for this service:
PUT/client/PutClientPersonAvailability
PutClientPersonAvailability Parameters:
NameParameterData TypeRequiredDescription
PersonAvailabilitybodyClientPersonAvailabilityApiModelNo
ClientPersonAvailabilityApiModel Parameters:
NameParameterData TypeRequiredDescription
UserPersonIdformlongNo
WeekDayIdformintNo
AvailableFromformlong?No
AvailableToformlong?No
HelperAvailabilityformboolNo
ClientPersonAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
PersonIdformlong?No
AccountIdformlongNo
WeekDayIdformintNo
AvailableFromformlong?No
AvailableToformlong?No
HelperAvailabilityformboolNo

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 /client/PutClientPersonAvailability HTTP/1.1 
Host: api.helferportal.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutClientPersonAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Routes">
  <PersonAvailability xmlns:d2p1="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.ApiModels.Person">
    <d2p1:AvailableFrom>0</d2p1:AvailableFrom>
    <d2p1:AvailableTo>0</d2p1:AvailableTo>
    <d2p1:HelperAvailability>false</d2p1:HelperAvailability>
    <d2p1:UserPersonId>0</d2p1:UserPersonId>
    <d2p1:WeekDayId>0</d2p1:WeekDayId>
  </PersonAvailability>
</PutClientPersonAvailability>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientPersonAvailabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Klientenportal.ApiModel.Models.Response.Person">
  <AccountId>0</AccountId>
  <AvailableFrom>0</AvailableFrom>
  <AvailableTo>0</AvailableTo>
  <HelperAvailability>false</HelperAvailability>
  <PersonId>0</PersonId>
  <WeekDayId>0</WeekDayId>
</ClientPersonAvailabilityResponse>