PRODUCTION
This webservice will return the full list of customers and its information of those who are related to the API consumer network.
Resource information |
|
Authentication |
Required |
HTTP Method |
GET |
Response |
JSON |
Version |
1 |
Resource URL
<https://www.mapapropapp.com/api/action/network-v1/get-customers>
Parameters
Key |
Type |
Required |
Description |
agencyId |
string |
no |
The agency ID in particular you want to retrieve. Useful when you get notified that a new customer was added to your network. |
Sample code
GET /api/action/network-v1/get-customers HTTP/1.1
Host: www.mapapropapp.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer ya29.1.AADtN_UxybTdjLw9jX6lg_SXIgc3wTtek4q2WvfETzSrz7Q6loEYoJEWd1x4qvlpGw
Response
A list of customers in an array belonging to the consumer network in JSON.
Object |
Field |
Type |
Required |
Description |
Customer |
agencyId |
string |
yes |
The agency ID of the mapaprop customer |
|
name |
string |
yes |
The name of the agency |
|
logo |
string |
yes |
The URL of the logo of the agency |
|
bio |
string |
no |
The bio of the agency |
|
address |
string |
yes |
Street address of the agency |
|
neighborhood |
string |
no |
Neighborhood of the location of the agency |
|
city |
string |
yes |
City of the location of the agency |
|
state |
string |
yes |
State or province of the location of the agency |
|
country |
string |
yes |
The country of the agency's location |
|
zipcode |
string |
yes |
The zip code of the agency's location |
|
email |
string |
yes |
The main email of the agency |
|
phone1 |
string |
yes |
The main phone number of the agency |
|
phone2 |
string |
no |
The secondary phone number of the agency |
|
phone3 |
string |
no |
The tertiary phone number of the agency |
|
mobile |
string |
no |
The mobile number of the agency, for instant messengers |
|
url |
string |
no |
The website url of the agency |
|
entity |
string |
no |
Registrant Legal Entity |
|
registration |
string |
no |
id in Registrant Legal Entity |
|
tempRental |
boolean |
no |
If the agency dedicates only to do temporary rentals |
Sample code
[
{
"custId": 0,
"agencyId": "ECID00128401EN",
"email": "[email protected]",
"name": "Servicios Inmobiliarios",
"phone1": "15-1111111",
"mobile": "541166662222",
"address": "San Martin 111",
"country": "Argentina",
"state": "Capital Federal",
"city": "Congreso",
"zipcode": "C1038AAZ",
"active": false,
"registration": "181818",
"entity": "CPI",
"url": "www.tuweb.com",
"tempRental": false,
"bio": "Empresa de servicios inmobiliarios.",
"logo": "<https://images.mapapropapp.com/mapaprop-image/logos/1/logo.gif>"
}
]