POST bizlocator/addvisit/{secretKey}
This function will add the property as visited.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| secretKey |
is used to authenticate user |
string |
Required |
Body Parameters
is used to add visit
AddBizLocatorLinkVisitParameters| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerId |
Identity of customer |
integer |
None. |
| Id |
Id of property needs to add |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"CustomerId": 1,
"Id": 2
}
application/xml, text/xml
Sample:
<AddBizLocatorLinkVisitParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmnicasaApiv3.Parameters"> <CustomerId>1</CustomerId> <Id>2</Id> </AddBizLocatorLinkVisitParameters>
Response Information
Resource Description
Return data
ReturnResultOfBoolean| Name | Description | Type | Additional information |
|---|---|---|---|
| Success |
Value = true is successful (If this value = false, then we should see Code and Message to have more info about error.) |
boolean |
None. |
| Code |
It's error code (If value = 0, it's successful) |
integer |
None. |
| Message |
It's error message (If value = empty, it's successful). |
string |
None. |
| Value |
Data which you need to get. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Code": 2,
"Message": "sample string 3",
"Value": true
}
application/xml, text/xml
Sample:
<ReturnResultOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmnicasaApiv3.Models"> <Code>2</Code> <Message>sample string 3</Message> <Success>true</Success> <Value>true</Value> </ReturnResultOfboolean>