GET v1/enterprise/locations?pageNumber={pageNumber}&modifiedStartDate={modifiedStartDate}&modifiedEndDate={modifiedEndDate}&pageSize={pageSize}
API for fetching Enterprise customer locations data order by tenant Id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| pageNumber |
PageNumber retrives Defatul to 1 |
integer |
Required |
| modifiedStartDate |
Filters employees modfied on or after this date |
date |
Required |
| modifiedEndDate |
Filters employees modfied on or after this date |
date |
Required |
| pageSize |
Number of results per page Default to 25 |
integer |
Default value is 100 |
Body Parameters
None.
Response Information
Resource Description
Returns Paginated Locations data order by Tenant Id
EnterpriseLocationsData| Name | Description | Type | Additional information |
|---|---|---|---|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| TotalItems | integer |
None. |
|
| TotalPages | integer |
None. |
|
| Data | Collection of LocationInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"PageNumber": 10,
"PageSize": 25,
"TotalItems": 1291,
"TotalPages": 30,
"Data": [
{
"QQTenantID": 2345,
"LocationID": 892,
"LocationName": "New York Base",
"IsDefault": true,
"QQID": "QQ022257",
"Alias": "denver(1)",
"StreetAddressLine1": "Flat 2.76.5",
"StreetAddressLine2": "Road 10,NW Road",
"City": "Denver",
"State": "FL",
"Zip": "23456"
},
{
"QQTenantID": 2345,
"LocationID": 892,
"LocationName": "New York Base",
"IsDefault": true,
"QQID": "QQ022257",
"Alias": "denver(1)",
"StreetAddressLine1": "Flat 2.76.5",
"StreetAddressLine2": "Road 10,NW Road",
"City": "Denver",
"State": "FL",
"Zip": "23456"
}
]
}
application/xml, text/xml
Sample:
<EnterpriseLocationsData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.EnterpriseModels">
<Data>
<LocationInfo>
<Alias>denver(1)</Alias>
<BusinessFEIN>93-7978099</BusinessFEIN>
<City>Denver</City>
<ContactFirstName>John</ContactFirstName>
<ContactLastName>Smith</ContactLastName>
<DefaultEmailAccountId>4</DefaultEmailAccountId>
<DefaultEmployeeId>1234</DefaultEmployeeId>
<DefaultStateCode>FL</DefaultStateCode>
<EmailAddress>johnsmith@domain.com</EmailAddress>
<Fax>917-987-6543</Fax>
<IsDefault>true</IsDefault>
<LocationID>892</LocationID>
<LocationName>New York Base</LocationName>
<MainClientId>19899</MainClientId>
<PhoneNumber>555-555-1234</PhoneNumber>
<QQID>QQ022257</QQID>
<QQTenantID>2345</QQTenantID>
<State>FL</State>
<StreetAddressLine1>Flat 2.76.5</StreetAddressLine1>
<StreetAddressLine2>Road 10,NW Road</StreetAddressLine2>
<Zip>23456</Zip>
</LocationInfo>
<LocationInfo>
<Alias>denver(1)</Alias>
<BusinessFEIN>93-7978099</BusinessFEIN>
<City>Denver</City>
<ContactFirstName>John</ContactFirstName>
<ContactLastName>Smith</ContactLastName>
<DefaultEmailAccountId>4</DefaultEmailAccountId>
<DefaultEmployeeId>1234</DefaultEmployeeId>
<DefaultStateCode>FL</DefaultStateCode>
<EmailAddress>johnsmith@domain.com</EmailAddress>
<Fax>917-987-6543</Fax>
<IsDefault>true</IsDefault>
<LocationID>892</LocationID>
<LocationName>New York Base</LocationName>
<MainClientId>19899</MainClientId>
<PhoneNumber>555-555-1234</PhoneNumber>
<QQID>QQ022257</QQID>
<QQTenantID>2345</QQTenantID>
<State>FL</State>
<StreetAddressLine1>Flat 2.76.5</StreetAddressLine1>
<StreetAddressLine2>Road 10,NW Road</StreetAddressLine2>
<Zip>23456</Zip>
</LocationInfo>
</Data>
<PageNumber>10</PageNumber>
<PageSize>25</PageSize>
<TotalItems>1291</TotalItems>
<TotalPages>30</TotalPages>
</EnterpriseLocationsData>