SendFreeTime - Obsolete

Description

This method is used to set the availability / free time of professionals. If a user wants to update the availability for a given date range it can be done by calling this method with updated information. Notes provided in the ProfessionalAvailability input is displayed in Boligmappa.no professional calendar. These notes can be used to inform property owners regarding special offers, services and other important company information. 

Request

Parameter
Type
Mandatory/Optional
Maximum character length/limit
Description

availability

List<ProfessionalAvailability>

Mandatory

Not relevant

List of free time of professionals of the company.
DateRange and NumberOfProfessionalsAvailable is mandatory in ProfessionalAvailability model. If no professionals are available, the NumberOfProfessionalsAvailable can be 0 (zero) for a given date range

applicationName

String

Mandatory

Should be less than or equal to 10 characters

The name of the integration partner.


Request - sample input

<SendFreeTime>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <availability attr0="ProfessionalAvailabilityArray" isNull="false">
      <ProfessionalAvailabilityArray0>
        <DateRange>
          <StartDate>12/5/2017 10:00:00 AM</StartDate>
          <EndDate>12/30/2017 10:00:00 AM</EndDate>
        </DateRange>
        <NumberOfProfessionalsAvailable>0</NumberOfProfessionalsAvailable>
        <Notes isNull="false" />
        <Rate>
          <LowestRatePerHour>20</LowestRatePerHour>
          <HighestRatePerHour>40</HighestRatePerHour>
          <IsTaxInclusive>False</IsTaxInclusive>
          <ChargingForTransport>False</ChargingForTransport>
        </Rate>
      </ProfessionalAvailabilityArray0>
    </availability>
    <applicationName>test</applicationName>
  </MethodParameters>
</SendFreeTime>

Response

Type
Description

bool

Status of the method 


Response - sample output 

<SendFreeTime>
  <MethodParameters>
    <Boolean>True</Boolean>
  </MethodParameters>
</SendFreeTime>


Exceptions

Error Code
Description

123

An exception occurred while processing your request

138

applicationName length has exceeded the maximum character limit allowed (10)

146

The applicationName is not set

167You are not authorized to use this method

271

DateRange is not provided

272StartDate and EndDate should be greater than or equal to the current date