GET v1/enterprise/employees?pageNumber={pageNumber}&modifiedStartDate={modifiedStartDate}&modifiedEndDate={modifiedEndDate}&pageSize={pageSize}
API for fetching Enterprise customer employees 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 Employees data order by Tenant Id
EnterpriseEmployeesDataName | Description | Type | Additional information |
---|---|---|---|
PageNumber | integer |
None. |
|
PageSize | integer |
None. |
|
TotalItems | integer |
None. |
|
TotalPages | integer |
None. |
|
Data | Collection of EmployeesInfo |
None. |
Response Formats
application/json, text/json
Sample:
{ "PageNumber": 10, "PageSize": 25, "TotalItems": 1291, "TotalPages": 30, "Data": [ { "QQTenantID": 2345, "DOB": "2024-12-11T05:59:14.9732321+00:00", "Zip": "54854", "City": "Denver", "Email": "rossjerry@domain.com", "Line1": "Flat 250", "Line2": "Road 10 New Jersey", "Phone": "765-476-4656", "State": "Texas", "County": "Wilcox", "Status": "A", "Country": "USA", "EntityID": 1254, "LastName": "Jerry", "AgentName": "Ross Jerry", "CreatedOn": "2024-12-11T05:59:14.9732321+00:00", "FirstName": "Ross", "PhoneType": "Home", "isAPerson": true, "CustomerNo": "6584", "LocationID": 892, "MiddleName": "Geller", "ContactType": "P", "DisplayName": "Johnwin", "TypeDisplay": "E", "BusinessName": "New Agency LLP", "StatusDisplay": "Active", "ContactSubType": "C", "PrimaryContact": "ross@domain.com", "HasBeenModified": true, "MaritalStatusID": 12, "ContactTypeDisplay": "Employee", "ContactSubTypeDisplay": "Customer" }, { "QQTenantID": 2345, "DOB": "2024-12-11T05:59:14.9732321+00:00", "Zip": "54854", "City": "Denver", "Email": "rossjerry@domain.com", "Line1": "Flat 250", "Line2": "Road 10 New Jersey", "Phone": "765-476-4656", "State": "Texas", "County": "Wilcox", "Status": "A", "Country": "USA", "EntityID": 1254, "LastName": "Jerry", "AgentName": "Ross Jerry", "CreatedOn": "2024-12-11T05:59:14.9732321+00:00", "FirstName": "Ross", "PhoneType": "Home", "isAPerson": true, "CustomerNo": "6584", "LocationID": 892, "MiddleName": "Geller", "ContactType": "P", "DisplayName": "Johnwin", "TypeDisplay": "E", "BusinessName": "New Agency LLP", "StatusDisplay": "Active", "ContactSubType": "C", "PrimaryContact": "ross@domain.com", "HasBeenModified": true, "MaritalStatusID": 12, "ContactTypeDisplay": "Employee", "ContactSubTypeDisplay": "Customer" } ] }
application/xml, text/xml
Sample:
<EnterpriseEmployeesData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.EnterpriseModels"> <Data> <EmployeesInfo> <AgentName>Ross Jerry</AgentName> <BusinessName>New Agency LLP</BusinessName> <City>Denver</City> <ContactSubType>C</ContactSubType> <ContactSubTypeDisplay>Customer</ContactSubTypeDisplay> <ContactType>P</ContactType> <ContactTypeDisplay>Employee</ContactTypeDisplay> <Country>USA</Country> <County>Wilcox</County> <CreatedOn>2024-12-11T05:59:14.9732321+00:00</CreatedOn> <CustomerNo>6584</CustomerNo> <DOB>2024-12-11T05:59:14.9732321+00:00</DOB> <DateLastModified>2024-12-11T05:59:14.9732321+00:00</DateLastModified> <DisplayName>Johnwin</DisplayName> <Email>rossjerry@domain.com</Email> <EntityID>1254</EntityID> <FirstName>Ross</FirstName> <HasBeenModified>true</HasBeenModified> <LastName>Jerry</LastName> <Line1>Flat 250</Line1> <Line2>Road 10 New Jersey</Line2> <LocationID>892</LocationID> <MaritalStatusID>12</MaritalStatusID> <MiddleName>Geller</MiddleName> <Phone>765-476-4656</Phone> <PhoneType>Home</PhoneType> <PrimaryContact>ross@domain.com</PrimaryContact> <QQTenantID>2345</QQTenantID> <State>Texas</State> <Status>A</Status> <StatusDisplay>Active</StatusDisplay> <TypeDisplay>E</TypeDisplay> <Zip>54854</Zip> <isAPerson>true</isAPerson> </EmployeesInfo> <EmployeesInfo> <AgentName>Ross Jerry</AgentName> <BusinessName>New Agency LLP</BusinessName> <City>Denver</City> <ContactSubType>C</ContactSubType> <ContactSubTypeDisplay>Customer</ContactSubTypeDisplay> <ContactType>P</ContactType> <ContactTypeDisplay>Employee</ContactTypeDisplay> <Country>USA</Country> <County>Wilcox</County> <CreatedOn>2024-12-11T05:59:14.9732321+00:00</CreatedOn> <CustomerNo>6584</CustomerNo> <DOB>2024-12-11T05:59:14.9732321+00:00</DOB> <DateLastModified>2024-12-11T05:59:14.9732321+00:00</DateLastModified> <DisplayName>Johnwin</DisplayName> <Email>rossjerry@domain.com</Email> <EntityID>1254</EntityID> <FirstName>Ross</FirstName> <HasBeenModified>true</HasBeenModified> <LastName>Jerry</LastName> <Line1>Flat 250</Line1> <Line2>Road 10 New Jersey</Line2> <LocationID>892</LocationID> <MaritalStatusID>12</MaritalStatusID> <MiddleName>Geller</MiddleName> <Phone>765-476-4656</Phone> <PhoneType>Home</PhoneType> <PrimaryContact>ross@domain.com</PrimaryContact> <QQTenantID>2345</QQTenantID> <State>Texas</State> <Status>A</Status> <StatusDisplay>Active</StatusDisplay> <TypeDisplay>E</TypeDisplay> <Zip>54854</Zip> <isAPerson>true</isAPerson> </EmployeesInfo> </Data> <PageNumber>10</PageNumber> <PageSize>25</PageSize> <TotalItems>1291</TotalItems> <TotalPages>30</TotalPages> </EnterpriseEmployeesData>