Description
...
Description
This method is used to set the availability / free time of professionals. If a user requires wants to update the availability for a given date range it can be done by calling this method again with updated information. Notes provided in the ProfessionalAvailability input will be is displayed in Boligmappa.no professional calendar. Therefore These notes can be used to inform property owners regarding special offers, services and other important company information of the company.
Request
Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
availability | List<ProfessionalAvailability> | Mandatory | Not relevant | List of free time of professionals of the company. |
applicationName | String | MandatoryThird party application identifier, identifying the client consuming the web service – (Length of the applicationName should | 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 web method execution |
...
method |
Response - sample output
<SendFreeTime>
<MethodParameters>
<Boolean>True</Boolean>
</MethodParameters>
</SendFreeTime>
Exceptions
Error Code | Description |
|---|---|
123 | An exception occured occurred while processing your request |
138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
146 | The application name applicationName is not set |
| 167 | You are not authorized to use this web method |
271 | Date Range DateRange is not provided |
| 272 | Start Date StartDate and End date EndDate should be greater than or equal to the current date |