PRODUCTION
This service will return the list of properties for the customer
Resource information |
|
Authentication |
Required |
HTTP Method |
GET |
Response |
JSON |
Version |
1 |
Resource URL
<https://mapaprop.app/api/action/portal-v2/customers>
Sample code
GET /api/action/portal-v2/customers?countyId=222&cityId=53&from=0&size=20&oauth_token=ya29.1.AADtN_UxybTdjLw9jX6lg_branSjjsldiwjtek4q2WvfETzSrz7Q6loEYoJEWd1x4qvlpGw. HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer ya29.1.AADtN_UxybTdjLw9jX6lg_branSjjsldiwjtek4q2WvfETzSrz7Q6loEYoJEWd1x4qvlpGw
Parameters
Key |
Type |
Required |
Description |
term |
string |
no |
A term that will try to match at least 3 characters in name field of the customer. Full text search capabilities. |
countryId |
int |
no |
The countryID of the property |
zone1 |
int |
no |
The state ID of the property |
zone2 |
int |
no |
The county ID of the property |
zone3 |
int |
no |
The city ID of the property |
Response
A JSON document with the list of zones in a hierarchy where the customer has properties.
Object |
Field |
Type |
Required |
Description |
Response |
took |
int |
yes |
How long the search took in milliseconds |
|
total |
int |
yes |
How many total records are in the context of this search. You can paginate thru them |
|
Filters |
Array of filters |
yes |
The list of filters in url |
|
customers |
Array of customers |
yes |
The list of customer objects |
Customer |
customerId |
string |
yes |
A unique ID for the customer |
|
more data… |
string |
yes |
some data |
Sample response
{
"took": 11,
"total": 197,
"filters": [...],
"customers": [
{
"customerId": 123,
...
}
]
}