API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

To get started, see Data Connect Guide.

Note

For reports that provide optional URI parameters for filtering at different levels (ForWho/ForWhoIDs/LocationType/LocationTypeIDs), omitting these values will run the report at the default company level.

Authentication

This API supports many different methods of authentication, see Authentication Options.

Rate Limiting

Example

HTTP 429 Too Many Requests
{
    "Error": true,
    "Message": "Rate Limiting Applied. 8 active requests are already in progress."
}

Data Connect limits the number of concurrent requests you can perform per RQ Database.

If the rate limit is exceeded, the response will be HTTP 429 and you will not be able to make additional requests until a previously made request finishes.

ENDPOINTS

RESOURCES

EmployeeListReportData

[
    {
        "Address": "127 starlight lane",
        "Cellular_Number": "5555555555",
        "City": "Fargo",
        "DefaultLocation": null,
        "DefaultZoneForWho": null,
        "Email": "sams@kentel.com",
        "EmailAddress": "sams@kentel.com",
        "Employee_Name": "Sam Smith",
        "ID_Number": 59,
        "IsPartTime": false,
        "Last_Name": "Smith",
        "LastHireDate": "2015-07-03T22:31:05.403",
        "Location": "100: My Network LLC - Anchorage",
        "PersonalEmail": "sam@yopmail.com",
        "Postal_Code": "90123",
        "Province": "ND",
        "RoleDescription": "Sales Representative",
        "ScheduledTerminationDate": "2015-11-22T08:00:00.000",
        "SMS_Number": "5555555555@yopmail.com",
        "SpecialIdentifier": "912345987654321",
        "StartDate": "2010-11-22T10:06:35.133",
        "Status": "Enabled",
        "TerminationDate": "2015-11-22T08:00:25.345",
        "Title": "Wireless Consultant",
        "Username": "Sam.Smith",
        "Work_Number": "5555555555"
    }
]
Name Description
Address (VARCHAR(50)) Address - employee’s address
Cellular_Number (NVARCHAR(MAX)) Cell Phone # - employee’s cell phone number
City (VARCHAR(50)) City - employee’s city
DefaultLocation (INT) Primary Location - primary location if one has been assigned. DefaultLocation and DefaultZoneForWho are used to determine this value
DefaultZoneForWho (TINYINT) Primary Location - primary location if one has been assigned. DefaultLocation and DefaultZoneForWho are used to determine this value
Email (VARCHAR(50)) Email Address - employee’s work email address
EmailAddress (VARCHAR(50)) Email
Employee_Name (VARCHAR(51)) Employee - name of the employee as entered on their employee profile
ID_Number (INT) Internal identifier for employee in RQ
IsPartTime (BIT) Part Time - indicates if an employee is Part Time
Last_Name (VARCHAR(25)) Employee last name
LastHireDate (VARCHAR(50)) Hire Date - day and date the employee was hired
Location (VARCHAR(51)) Location - Only present if Unique is not -1. Every location the employee is assigned to
PersonalEmail (VARCHAR(50)) Personal Email - employee’s personal email address
Postal_Code (VARCHAR(15)) Zip/Postal Code - zip code (USA) or postal code (Canada)
Province (VARCHAR(50)) Province - employee’s province or state
RoleDescription (NVARCHAR(MAX)) Security Role - security role assigned to this employee
ScheduledTerminationDate (DateTime) Scheduled termination date
SMS_Number (VARCHAR(50)) SMS # - employee’s text number
SpecialIdentifier (VARCHAR(25)) ID # - ID number assigned when hired
StartDate (DateTime) Start Date
Status (VARCHAR(8)) Status - shows if the employee is enabled or disabled if Any Status is selected
TerminationDate (DateTime) Termination Date - date of termination (date the employee was disabled)
Title (VARCHAR(50)) Title - title assigned to this employee
Username (VARCHAR(25)) Username - username of the employee as entered on their employee profile
Work_Number (DateTime) Work Phone # - employee’s work number

LocationMasterListReportData

[
    {
        "Abbreviation": "LIT22",
        "Address": "4970 Hillside Avenue",
        "AddressVerified": "Not Verified",
        "AdjustDST": false,
        "BankDetails": "CashSmart",
        "CashPolicy": "Single-Drawer",
        "ChannelName": "Alabama",
        "City": "Kansas",
        "Comment_on_OE": false,
        "Country": "United States",
        "DepositTaken": 0,
        "Disabled": 1,
        "DistrictName": "Smithton",
        "EmailAddress": "abarea@kentel.com",
        "FaxNumber": "5555555555",
        "GeneralLocationNotes": "note",
        "GLCode": "-MILLH",
        "HideCustomerAddress": false,
        "InsuranceAmount": 0,
        "InsuranceCompany": "Safefair",
        "LandlordName": "Jim Jones",
        "LandlordNotes": "sample note",
        "Latitude": 50.443559,
        "LeaseEndDate": "2014-12-24T00:00:00",
        "LeaseNotes": "note",
        "LeaseStartDate": "2014-11-26T00:00:00",
        "LocationCode": "500",
        "LocationEntityID": 48540,
        "Longitude": -104.612034,
        "ManagerCommissionable": false,
        "ManagerEmployeeID": 233,
        "MaxCashDrawer": 0,
        "OtherCharges": 0,
        "PAW_on_OE": false,
        "Phone_on_OE": true,
        "PhoneNumber": "4353424234",
        "PropertyTaxes": 0,
        "RegionName": "Abarea",
        "RelocationDate": "2016-02-26T00:00:00",
        "Rent": 0,
        "SaleInvoiceComment": "Sale Invoice Comments",
        "Serial_on_OE": false,
        "SquareFootage": 0,
        "StaffLevel": 12,
        "StateProv": "AL",
        "StoreID": 1187,
        "StoreName": "Dufferin Mall",
        "StoreType": "Retail Store",
        "Taxes": "GOODS AND SERVICES TAX (GST)",
        "TimeZone": "(GMT-06:00) Saskatchewan",
        "UseLocationEmail": false,
        "ZipPostal": "90210"
    }
]
Name Description
Abbreviation (VARCHAR(5)) Abbreviation - this cannot be edited
Address (NVARCHAR(MAX)) Address - address assigned to location
AddressVerified (VARCHAR(12)) Address Verified - if the address can not be verified then you will have the option to edit the Latitude and Longitude to verify it
AdjustDST (BIT) Adjust DST - check if the location adjusts for daylight savings
BankDetails (NVARCHAR(MAX)) Bank Details - the Banks name for the location
CashPolicy (VARCHAR(13)) Cash Policy - states the cash policy (single/multi-drawer)
ChannelName (NVARCHAR(MAX)) Channel - channel the region is assigned to
City (VARCHAR(50)) City - city the location resides in
Comment_on_OE (BIT) Comment on OE - show product and location comments on sales order
Country (VARCHAR(50)) Country - country the location is located in
DepositTaken (MONEY) Deposit Taken - lists the deposit if applicable
Disabled (INT) Disable - indicates if the location is enabled or disabled
DistrictName (NVARCHAR(MAX)) District - district the location is assigned to
EmailAddress (VARCHAR(255)) Email Address - email address assigned to the location
FaxNumber (VARCHAR(10)) Fax # - Fax # listed under the location
GeneralLocationNotes (VARCHAR(255)) General Location Notes - notes specific to the location
GLCode (VARCHAR(100)) Code - coded associated to the location
HideCustomerAddress (BIT) Hide Customer Address - prevents the customers address from being seen on an invoice
InsuranceAmount (MONEY) Insurance - cost of Insurance
InsuranceCompany (NVARCHAR(MAX)) Insurance Company - name of the insurance company
LandlordName (NVARCHAR(MAX)) Landlord Name - name of the landlord
LandlordNotes (NVARCHAR(MAX)) Landlord Notes - notes specific to the landlord
Latitude (DECIMAL) Latitude - latitude location of the store
LeaseEndDate (DateTime) Lease End Date - the day the lease ends
LeaseNotes (NVARCHAR(MAX)) Lease Notes - notes specific to the lease
LeaseStartDate (DateTime) Lease Start Date - day the lease started
LocationCode (VARCHAR(100)) Location Code - code entered in the property details tab in the Location Setup
LocationEntityID (INT) Identifier of the store as a Location in Entity Store
Longitude (DECIMAL) Longitude - longitude location of the store
ManagerCommissionable (BIT) Manager Commissionable - indicates if the manager is commissionable.
ManagerEmployeeID (INT) Manager - manager assigned to the location
MaxCashDrawer (MONEY) Max Cash Drawer - maximum amount of cash allowed in a cash drawer
OtherCharges (MONEY) Other Charges - other charges associated to the location
PAW_on_OE (BIT) PAW on OE - launch PAW on sales orders
Phone_on_OE (BIT) Force phone number for entry on sales orders
PhoneNumber (VARCHAR(10)) Phone # - designated number for the location
PropertyTaxes (MONEY) Property Taxes - applicable property taxes
RegionName (NVARCHAR(MAX)) Region - region the district is assigned to
RelocationDate (DateTime) Relocation Date - lists the date of the relocation if applicable
Rent (MONEY) Rent - rent amount for the location
SaleInvoiceComment (NVARCHAR(MAX)) Sale Invoice Comment - locations sales invoice comment
Serial_on_OE (BIT) Serial # on OE - force serial # for entry on sales orders
SquareFootage (INT) Square Feet - approx square feet of the store
StaffLevel (DECIMAL) Staff Level - designated staffing level for the location
StateProv (NVARCHAR(3)) State/Prov - state or province the location is located in
StoreID (INT) Internal identifier for the store in RQ
StoreName (NVARCHAR(MAX)) Store Name - name of the store
StoreType (NVARCHAR(MAX)) Store Type - will state the store type
Taxes (NVARCHAR(MAX)) Taxes - taxes assigned to the location
TimeZone (VARCHAR(200)) Time Zone - time zone assigned to location
UseLocationEmail (BIT) Use Location for Email - use the location for the email contact
ZipPostal (VARCHAR(15)) Zip/Postal - zip/postal for the location

Relationship

[
    {
        "CompanyID": 21090,
        "CompanyName": "KENTEL",
        "DoingBusinessAs": "Kentel Corp"
    }
]
Name Description
CompanyID (INTEGER) Identifier for a Company
CompanyName (VARCHAR(50)) Database name
DoingBusinessAs (NVARCHAR(MAX)) Company name

DealerRelationship

[
    {
        "CompanyID": 14146,
        "CompanyName": "KENTEL",
        "LocationEntityID": 14192,
        "LocationName": "Region A"
    }
]
Name Description
CompanyID (BIGINT) Identifier for a Company
CompanyName (NVARCHAR(128)) Company name
LocationEntityID (BIGINT) Identifier for the Location, Region, Channel or District in Entity Store
LocationName (NVARCHAR(MAX)) Name of the Location, Region, Channel or District

REQUESTS

GET Dealer Relationships

This request returns a list of LocationEntityIDs and Names for a Company that the partner can access.

When the response contains multiple resouces with the same CompanyID, the partner can access multiple nodes within the Company.

Example

The below response means the partner can access data on behalf of the company KENTEL using the context of Region 1 (LocationEntityID 14189) or Region 2 (LocationEntityID 14188).

{
  "CompanyID": 14146,
  "CompanyName": "MasterCompany",
  "LocationEntityID": 14189,
  "LocationName": "Child Dealer 1"
},
{
  "CompanyID": 14146,
  "CompanyName": "MasterCompany",
  "LocationEntityID": 14188,
  "LocationName": "Child Dealer 2"
}

Definition

GET /partner/relationships/dealers?Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/relationships/dealers
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingDealerRelationships()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingDealerRelationships() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/relationships/dealers', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[DealerRelationship]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CompanyID": 14146,
        "CompanyName": "KENTEL",
        "LocationEntityID": 14192,
        "LocationName": "Region A"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CompanyID": 14146,
            "CompanyName": "KENTEL",
            "LocationEntityID": 14192,
            "LocationName": "Region A"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CompanyID>14146</CompanyID>
    <CompanyName>KENTEL</CompanyName>
    <LocationEntityID>14192</LocationEntityID>
    <LocationName>Region A</LocationName>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CompanyID,CompanyName,LocationEntityID,LocationName
14146,KENTEL,14192,Region A

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET Partner Relationships

This request will return a list of Companies the Partner can access data from.

If the response is empty, use the request Getting Dealer Relationships instead.

Definition

GET /partner/relationships?Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/relationships
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/relationships" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingPartnerRelationships()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/relationships");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingPartnerRelationships() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/relationships");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/relationships', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[Relationship]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CompanyID": 21090,
        "CompanyName": "KENTEL",
        "DoingBusinessAs": "Kentel Corp"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CompanyID": 21090,
            "CompanyName": "KENTEL",
            "DoingBusinessAs": "Kentel Corp"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CompanyID>21090</CompanyID>
    <CompanyName>KENTEL</CompanyName>
    <DoingBusinessAs>Kentel Corp</DoingBusinessAs>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
CompanyID,CompanyName,DoingBusinessAs
21090,KENTEL,Kentel Corp

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET the Employee List Report

For more information, see Employee List Report.

Definition

GET /partner/SellPro/employeelistreport?CompanyId={CompanyId}&Status={Status}&Unique={Unique}&GroupID={GroupID}&LocationEntityID={LocationEntityID}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/SellPro/employeelistreport?CompanyId=14831&Status=1&Unique=false&GroupID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/SellPro/employeelistreport?CompanyId=14831&Status=1&Unique=false&GroupID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheEmployeeListReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/SellPro/employeelistreport?CompanyId=14831&Status=1&Unique=false&GroupID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTheEmployeeListReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/SellPro/employeelistreport?CompanyId=14831&Status=1&Unique=false&GroupID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/SellPro/employeelistreport?CompanyId=14831&Status=1&Unique=false&GroupID=-1&LocationEntityID=14188&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[EmployeeListReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Address": "127 starlight lane",
        "Cellular_Number": "5555555555",
        "City": "Fargo",
        "DefaultLocation": null,
        "DefaultZoneForWho": null,
        "Email": "sams@kentel.com",
        "EmailAddress": "sams@kentel.com",
        "Employee_Name": "Sam Smith",
        "ID_Number": 59,
        "IsPartTime": false,
        "Last_Name": "Smith",
        "LastHireDate": "2015-07-03T22:31:05.403",
        "Location": "100: My Network LLC - Anchorage",
        "PersonalEmail": "sam@yopmail.com",
        "Postal_Code": "90123",
        "Province": "ND",
        "RoleDescription": "Sales Representative",
        "ScheduledTerminationDate": "2015-11-22T08:00:00.000",
        "SMS_Number": "5555555555@yopmail.com",
        "SpecialIdentifier": "912345987654321",
        "StartDate": "2010-11-22T10:06:35.133",
        "Status": "Enabled",
        "TerminationDate": "2015-11-22T08:00:25.345",
        "Title": "Wireless Consultant",
        "Username": "Sam.Smith",
        "Work_Number": "5555555555"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Address": "127 starlight lane",
            "Cellular_Number": "5555555555",
            "City": "Fargo",
            "DefaultLocation": null,
            "DefaultZoneForWho": null,
            "Email": "sams@kentel.com",
            "EmailAddress": "sams@kentel.com",
            "Employee_Name": "Sam Smith",
            "ID_Number": 59,
            "IsPartTime": false,
            "Last_Name": "Smith",
            "LastHireDate": "2015-07-03T22:31:05.403",
            "Location": "100: My Network LLC - Anchorage",
            "PersonalEmail": "sam@yopmail.com",
            "Postal_Code": "90123",
            "Province": "ND",
            "RoleDescription": "Sales Representative",
            "ScheduledTerminationDate": "2015-11-22T08:00:00.000",
            "SMS_Number": "5555555555@yopmail.com",
            "SpecialIdentifier": "912345987654321",
            "StartDate": "2010-11-22T10:06:35.133",
            "Status": "Enabled",
            "TerminationDate": "2015-11-22T08:00:25.345",
            "Title": "Wireless Consultant",
            "Username": "Sam.Smith",
            "Work_Number": "5555555555"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Address>127 starlight lane</Address>
    <Cellular_Number>5555555555</Cellular_Number>
    <City>Fargo</City>
    <DefaultLocation>null</DefaultLocation>
    <DefaultZoneForWho>null</DefaultZoneForWho>
    <Email>sams@kentel.com</Email>
    <EmailAddress>sams@kentel.com</EmailAddress>
    <Employee_Name>Sam Smith</Employee_Name>
    <ID_Number>59</ID_Number>
    <IsPartTime>false</IsPartTime>
    <Last_Name>Smith</Last_Name>
    <LastHireDate>2015-07-03T22:31:05.403</LastHireDate>
    <Location>100: My Network LLC - Anchorage</Location>
    <PersonalEmail>sam@yopmail.com</PersonalEmail>
    <Postal_Code>90123</Postal_Code>
    <Province>ND</Province>
    <RoleDescription>Sales Representative</RoleDescription>
    <ScheduledTerminationDate>2015-11-22T08:00:00.000</ScheduledTerminationDate>
    <SMS_Number>5555555555@yopmail.com</SMS_Number>
    <SpecialIdentifier>912345987654321</SpecialIdentifier>
    <StartDate>2010-11-22T10:06:35.133</StartDate>
    <Status>Enabled</Status>
    <TerminationDate>2015-11-22T08:00:25.345</TerminationDate>
    <Title>Wireless Consultant</Title>
    <Username>Sam.Smith</Username>
    <Work_Number>5555555555</Work_Number>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
Address,Cellular_Number,City,DefaultLocation,DefaultZoneForWho,Email,EmailAddress,Employee_Name,ID_Number,IsPartTime,Last_Name,LastHireDate,Location,PersonalEmail,Postal_Code,Province,RoleDescription,ScheduledTerminationDate,SMS_Number,SpecialIdentifier,StartDate,Status,TerminationDate,Title,Username,Work_Number
127 starlight lane,5555555555,Fargo,null,null,sams@kentel.com,sams@kentel.com,Sam Smith,59,false,Smith,2015-07-03T22:31:05.403,100: My Network LLC - Anchorage,sam@yopmail.com,90123,ND,Sales Representative,2015-11-22T08:00:00.000,5555555555@yopmail.com,912345987654321,2010-11-22T10:06:35.133,Enabled,2015-11-22T08:00:25.345,Wireless Consultant,Sam.Smith,5555555555

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

GET the Location Master List Report

For more information, see Location Master List Report.

Definition

GET /partner/SellPro/locationmasterlistreport?CompanyId={CompanyId}&LocationEntityID={LocationEntityID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /partner/SellPro/locationmasterlistreport?CompanyId=14831&LocationEntityID=14188
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/partner/SellPro/locationmasterlistreport?CompanyId=14831&LocationEntityID=14188" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheLocationMasterListReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/partner/SellPro/locationmasterlistreport?CompanyId=14831&LocationEntityID=14188");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept-Encoding", "gzip"); 

    

    return client.Execute(request);
}

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import java.io.IOException;

public static CloseableHttpResponse GettingTheLocationMasterListReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/partner/SellPro/locationmasterlistreport?CompanyId=14831&LocationEntityID=14188");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept-Encoding", "gzip"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/partner/SellPro/locationmasterlistreport?CompanyId=14831&LocationEntityID=14188', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[LocationMasterListReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Abbreviation": "LIT22",
        "Address": "4970 Hillside Avenue",
        "AddressVerified": "Not Verified",
        "AdjustDST": false,
        "BankDetails": "CashSmart",
        "CashPolicy": "Single-Drawer",
        "ChannelName": "Alabama",
        "City": "Kansas",
        "Comment_on_OE": false,
        "Country": "United States",
        "DepositTaken": 0,
        "Disabled": 1,
        "DistrictName": "Smithton",
        "EmailAddress": "abarea@kentel.com",
        "FaxNumber": "5555555555",
        "GeneralLocationNotes": "note",
        "GLCode": "-MILLH",
        "HideCustomerAddress": false,
        "InsuranceAmount": 0,
        "InsuranceCompany": "Safefair",
        "LandlordName": "Jim Jones",
        "LandlordNotes": "sample note",
        "Latitude": 50.443559,
        "LeaseEndDate": "2014-12-24T00:00:00",
        "LeaseNotes": "note",
        "LeaseStartDate": "2014-11-26T00:00:00",
        "LocationCode": "500",
        "LocationEntityID": 48540,
        "Longitude": -104.612034,
        "ManagerCommissionable": false,
        "ManagerEmployeeID": 233,
        "MaxCashDrawer": 0,
        "OtherCharges": 0,
        "PAW_on_OE": false,
        "Phone_on_OE": true,
        "PhoneNumber": "4353424234",
        "PropertyTaxes": 0,
        "RegionName": "Abarea",
        "RelocationDate": "2016-02-26T00:00:00",
        "Rent": 0,
        "SaleInvoiceComment": "Sale Invoice Comments",
        "Serial_on_OE": false,
        "SquareFootage": 0,
        "StaffLevel": 12,
        "StateProv": "AL",
        "StoreID": 1187,
        "StoreName": "Dufferin Mall",
        "StoreType": "Retail Store",
        "Taxes": "GOODS AND SERVICES TAX (GST)",
        "TimeZone": "(GMT-06:00) Saskatchewan",
        "UseLocationEmail": false,
        "ZipPostal": "90210"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Abbreviation": "LIT22",
            "Address": "4970 Hillside Avenue",
            "AddressVerified": "Not Verified",
            "AdjustDST": false,
            "BankDetails": "CashSmart",
            "CashPolicy": "Single-Drawer",
            "ChannelName": "Alabama",
            "City": "Kansas",
            "Comment_on_OE": false,
            "Country": "United States",
            "DepositTaken": 0,
            "Disabled": 1,
            "DistrictName": "Smithton",
            "EmailAddress": "abarea@kentel.com",
            "FaxNumber": "5555555555",
            "GeneralLocationNotes": "note",
            "GLCode": "-MILLH",
            "HideCustomerAddress": false,
            "InsuranceAmount": 0,
            "InsuranceCompany": "Safefair",
            "LandlordName": "Jim Jones",
            "LandlordNotes": "sample note",
            "Latitude": 50.443559,
            "LeaseEndDate": "2014-12-24T00:00:00",
            "LeaseNotes": "note",
            "LeaseStartDate": "2014-11-26T00:00:00",
            "LocationCode": "500",
            "LocationEntityID": 48540,
            "Longitude": -104.612034,
            "ManagerCommissionable": false,
            "ManagerEmployeeID": 233,
            "MaxCashDrawer": 0,
            "OtherCharges": 0,
            "PAW_on_OE": false,
            "Phone_on_OE": true,
            "PhoneNumber": "4353424234",
            "PropertyTaxes": 0,
            "RegionName": "Abarea",
            "RelocationDate": "2016-02-26T00:00:00",
            "Rent": 0,
            "SaleInvoiceComment": "Sale Invoice Comments",
            "Serial_on_OE": false,
            "SquareFootage": 0,
            "StaffLevel": 12,
            "StateProv": "AL",
            "StoreID": 1187,
            "StoreName": "Dufferin Mall",
            "StoreType": "Retail Store",
            "Taxes": "GOODS AND SERVICES TAX (GST)",
            "TimeZone": "(GMT-06:00) Saskatchewan",
            "UseLocationEmail": false,
            "ZipPostal": "90210"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Abbreviation>LIT22</Abbreviation>
    <Address>4970 Hillside Avenue</Address>
    <AddressVerified>Not Verified</AddressVerified>
    <AdjustDST>false</AdjustDST>
    <BankDetails>CashSmart</BankDetails>
    <CashPolicy>Single-Drawer</CashPolicy>
    <ChannelName>Alabama</ChannelName>
    <City>Kansas</City>
    <Comment_on_OE>false</Comment_on_OE>
    <Country>United States</Country>
    <DepositTaken>0</DepositTaken>
    <Disabled>1</Disabled>
    <DistrictName>Smithton</DistrictName>
    <EmailAddress>abarea@kentel.com</EmailAddress>
    <FaxNumber>5555555555</FaxNumber>
    <GeneralLocationNotes>note</GeneralLocationNotes>
    <GLCode>-MILLH</GLCode>
    <HideCustomerAddress>false</HideCustomerAddress>
    <InsuranceAmount>0</InsuranceAmount>
    <InsuranceCompany>Safefair</InsuranceCompany>
    <LandlordName>Jim Jones</LandlordName>
    <LandlordNotes>sample note</LandlordNotes>
    <Latitude>50.443559</Latitude>
    <LeaseEndDate>2014-12-24T00:00:00</LeaseEndDate>
    <LeaseNotes>note</LeaseNotes>
    <LeaseStartDate>2014-11-26T00:00:00</LeaseStartDate>
    <LocationCode>500</LocationCode>
    <LocationEntityID>48540</LocationEntityID>
    <Longitude>-104.612034</Longitude>
    <ManagerCommissionable>false</ManagerCommissionable>
    <ManagerEmployeeID>233</ManagerEmployeeID>
    <MaxCashDrawer>0</MaxCashDrawer>
    <OtherCharges>0</OtherCharges>
    <PAW_on_OE>false</PAW_on_OE>
    <Phone_on_OE>true</Phone_on_OE>
    <PhoneNumber>4353424234</PhoneNumber>
    <PropertyTaxes>0</PropertyTaxes>
    <RegionName>Abarea</RegionName>
    <RelocationDate>2016-02-26T00:00:00</RelocationDate>
    <Rent>0</Rent>
    <SaleInvoiceComment>Sale Invoice Comments</SaleInvoiceComment>
    <Serial_on_OE>false</Serial_on_OE>
    <SquareFootage>0</SquareFootage>
    <StaffLevel>12</StaffLevel>
    <StateProv>AL</StateProv>
    <StoreID>1187</StoreID>
    <StoreName>Dufferin Mall</StoreName>
    <StoreType>Retail Store</StoreType>
    <Taxes>GOODS AND SERVICES TAX (GST)</Taxes>
    <TimeZone>(GMT-06:00) Saskatchewan</TimeZone>
    <UseLocationEmail>false</UseLocationEmail>
    <ZipPostal>90210</ZipPostal>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
Abbreviation,Address,AddressVerified,AdjustDST,BankDetails,CashPolicy,ChannelName,City,Comment_on_OE,Country,DepositTaken,Disabled,DistrictName,EmailAddress,FaxNumber,GeneralLocationNotes,GLCode,HideCustomerAddress,InsuranceAmount,InsuranceCompany,LandlordName,LandlordNotes,Latitude,LeaseEndDate,LeaseNotes,LeaseStartDate,LocationCode,LocationEntityID,Longitude,ManagerCommissionable,ManagerEmployeeID,MaxCashDrawer,OtherCharges,PAW_on_OE,Phone_on_OE,PhoneNumber,PropertyTaxes,RegionName,RelocationDate,Rent,SaleInvoiceComment,Serial_on_OE,SquareFootage,StaffLevel,StateProv,StoreID,StoreName,StoreType,Taxes,TimeZone,UseLocationEmail,ZipPostal
LIT22,4970 Hillside Avenue,Not Verified,false,CashSmart,Single-Drawer,Alabama,Kansas,false,United States,0,1,Smithton,abarea@kentel.com,5555555555,note,-MILLH,false,0,Safefair,Jim Jones,sample note,50.443559,2014-12-24T00:00:00,note,2014-11-26T00:00:00,500,48540,-104.612034,false,233,0,0,false,true,4353424234,0,Abarea,2016-02-26T00:00:00,0,Sale Invoice Comments,false,0,12,AL,1187,Dufferin Mall,Retail Store,GOODS AND SERVICES TAX (GST),(GMT-06:00) Saskatchewan,false,90210

Example Response (Excel)

HTTP 200 Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
content-disposition: attachment;filename=reportname-2016-07-11.xlsx
Binary *.xlsx file

ERRORS

HTTP Status Code Description How to Resolve
HTTP 400 Bad Request Ensure request body is formatted properly
HTTP 401 Token is invalid Ensure Access Token is valid and has not expired
HTTP 403 Unauthorized Ensure Access Token is valid and user has appropriate security
HTTP 404 Not Found Ensure URI is valid
HTTP 500 Unexpected Error See Message in response for more information
Was this page helpful?