API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

Data Connect allows you to retrieve report data from your RQ database (v4.23 and up).

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

Data Connect supports many different methods of authentication, see Authentication Options.

Note that for all reports the Access Token should be mapped to an employee in RQ.

REQUEST LIST

Requests are organized into two sections; Consoles allow you to retrieve data from different sections of RQ and Reports allow you to retrieve RQ report data.

Consoles

Reports

Sales Reports

Inventory Reports

Finance Reports

Other

ENDPOINTS

RESOURCES

LoggedRequest

[
    {
        "RequestID": "ba5fbc85-fe5c-fe10-0a4d-add4e13e83ac",
        "CompanyID": 14146,
        "CompanyName": "KENTEL",
        "UserManagerEmployeeID": 280494,
        "UserName": "John.Bates@KENTEL",
        "RQEmployeeID": 5121,
        "ClientIPAddress": "127.0.0.1",
        "DTCreated": "2017-04-05T16:52:41.26",
        "DTCompleted": "2017-04-05T16:56:10.50",
        "Records": 6,
        "Uri": "https://rqdataconnect1.iqmetrix.net/lists/employees",
        "MachineName": "IQ-TEST001",
        "StatusCode": 500,
        "Message": "Column 'DateCreated' is read only.",
        "Origin": ""
    }
]
Name Description
RequestID (UNIQUEIDENTIFIER) Unique identifier
CompanyID (BIGINT) Company identifier
CompanyName (NVARCHAR(128)) Company name
UserManagerEmployeeID (BIGINT) Identifier of user who performed request, in User Manager
UserName (NVARCHAR(256)) Username of user who performed request
RQEmployeeID (INT) Identifier of RQ employee who performed request
ClientIPAddress (NVARCHAR(48)) Originating IP Address for request
DTCreated (DateTime) Date and time request started, in UTC
DTCompleted (DateTime) Date and time request completed, in UTC
Records (BIGINT) Number of records returned from request
Uri (NVARCHAR(MAX)) Request URI
MachineName (NVARCHAR(128)) Name of iQmetrix server that performed request
StatusCode (INT) Error status code, null unless request returned error
Message (NVARCHAR(MAX)) Error message, null unless request returned error
Origin (NVARCHAR(MAX)) Origin of error message, null unless request returned error. This field helps determine which API caused the request to fail.

CategoryNumber

[
    {
        "ID": "10101",
        "Description": "Rate Plans",
        "CategoryPath": " >> Activations",
        "ParentID": "1010"
    }
]
Name Description
ID (VARCHAR(100)) Category Identifier
Description (NVARCHAR(MAX)) Category name
CategoryPath (NVARCHAR(MAX)) Category path
ParentID (VARCHAR(20)) Parent Category Identifier

RQCompanyTreeNode

[
    {
        "ID": 0,
        "Description": "KENTEL Corp",
        "EntityID": 14146
    }
]
Name Description
ID (INT) Identifier
Description (VARCHAR(255)) Description
EntityID (INT) Identifier for the appropriate CompanyTreeNode

ReasonCode

A ReasonCode allows an employee to provide a reason for an action, such as a ChargeBack. For example, Point of Sale Error.

[
    {
        "ID": "1",
        "Description": "Write Off"
    }
]
Name Description
ID (String) Identifier
Description (String) Reason

LocationType

[
    {
        "Type": "Channel"
    }
]
Name Description
Type (VARCHAR(8)) Name of a Location type in RQ

Group

[
    {
        "GroupID": 4,
        "GroupName": "100% (35% GP)"
    }
]
Name Description
GroupID (INT) Identifier
GroupName (VARCHAR(50)) Name

Coupon

[
    {
        "CouponID": 1144,
        "CouponName": "TEST2"
    }
]
Name Description
CouponID (INT) Identifier
CouponName (NVARCHAR(MAX)) Name

StoreType

[
    {
        "Type": 3,
        "StoreTypeName": "Kiosk"
    }
]
Name Description
Type (INT) Identifier
StoreTypeName (NVARCHAR(MAX)) Name

VendorID

[
    {
        "VendorID": 1,
        "VendorName": "A.C.P"
    }
]
Name Description
VendorID (INT) Identifier
VendorName (NVARCHAR(MAX)) Name

ProductType

[
    {
        "ProductTypeID": 0,
        "ProductType": "Regular Global Product"
    }
]
Name Description
ProductTypeID (INT) Identifier
ProductType (VARCHAR(30)) Name

NonSellableReasonCode

[
    {
        "ReasonCode": "c5473733-e030-83cf-7a9f-4e95a3c27efa",
        "ReasonCodeDescription": "Scratched"
    }
]
Name Description
ReasonCode (UNIQUEIDENTIFIER) Identifier
ReasonCodeDescription (NVARCHAR(MAX)) Reason code

SalesOpportunityType

[
    {
        "SalesOpportunityTypeID": 2,
        "Description": "New Activation"
    }
]
Name Description
SalesOpportunityTypeID (INT) Identifier
Description (NVARCHAR(MAX)) Description

ServiceType

[
    {
        "ServiceTypeID": 1,
        "Description": "newer"
    }
]
Name Description
ServiceTypeID (INT) Identifier
Description (NVARCHAR(MAX)) Description

PaymentTypeData

[
    {
        "PaymentTypeID": 0,
        "PaymentName": "Account"
    }
]
Name Description
PaymentTypeID (INT) Identifier
PaymentName (NVARCHAR(MAX)) Description

GLSourceType

[
    {
        "GL_SourceType": 0,
        "GP_SourceTypeName": "Opening Balance"
    }
]
Name Description
GL_SourceType (INT) Identifier
GP_SourceTypeName (NVARCHAR(50)) Description

VendorAccount

Vendor Accounts are created to help track any rebates or commissions that vendors or carriers pay you.

[
    {
        "VendorAccountID": 1,
        "VendorID": 18,
        "EmployeeID": 1,
        "StoreID": 13,
        "AccountName": "Verizon 2",
        "Comments": "",
        "DateCreated": "2010-06-30T07:45:08.197",
        "GLAccountID1": 1004,
        "RowTimeStamp": "AAAAAAA07EE=",
        "RequireSOCcode": 1,
        "ForcedSOCcodeLength": 10,
        "ForceSOCcodeLength": 1,
        "RequireExtraField": true,
        "ForcedExtraFieldLength": 5,
        "ForceExtraFieldLength": false,
        "ExtraFieldDescriptionID": "817e1a3d-2fb9-3c0e-cbde-5ec32cce8f3d",
        "UseExtraFieldAllowedValuesList": true,
        "UseAdvancedCarrierPriceSheet": true,
        "UseAdvancedSPIFFTracking": false,
        "UseLowestPrice": false,
        "EnableVendorSKU": false,
        "CarrierID": "77527370-cfb1-ecaf-9c57-0a7fe94ae745",
        "IsMasterAgentAccount": false,
        "UseCustomGLForVenRebAccPayment": false,
        "CustomGLAccountIDForVenRebAccPayment": 0,
        "LocalizationID": "0d653e99-53dc-f6db-3f78-77ed09fbf00b"
    }
]
Name Description
VendorAccountID (INT) Identifier for a Vendor Account in RQ
VendorID (INT) Identifier for an associated Vendor in RQ
EmployeeID (INT) Identifier for an associated Employee in RQ
StoreID (INT) Identifier for an associated Store in RQ
AccountName (VARCHAR(100)) Account Name - name for this account
Comments (VARCHAR(500)) Comments - enter any comments that need to be attached to the vendor account
DateCreated (DateTime) Created date
GLAccountID1 (INT) Select the G/L Account that Vendor Deposits Go Into - use the drop down or the magnifying glass to find the G/L account that will be linked to the vendor account.
RowTimeStamp (TIMESTAMP) Internal value in RQ
RequireSOCcode (TINYINT) Require SOC Code For Activations - if Require SOC Code for Activations has been checked off, you can then check the Enforce SOC Code Length box if you want to ensure the correct length of the SOC code is entered. If you check this box, you will need to enter how many characters the length of the SOC Code should be.
ForcedSOCcodeLength (INT) Required length of SOC code
ForceSOCcodeLength (TINYINT) A flag to indicate if the SOC code has a required length
RequireExtraField (BIT) Require Extra Field For Activations - check the Extra field to add an additional field that you want completed during the activation. this Extra Field information will display in the following areas: Reconcile Vendor Rebates, Reconcile Chargebacks, Vendor Rebate History Report and Search CRM report utility.
ForcedExtraFieldLength (INT) Required length of extra field
ForceExtraFieldLength (BIT) Enforce Field Length - check to open the Required Length box and enter the Required Length
ExtraFieldDescriptionID (UNIQUEIDENTIFIER) Internal value in RQ
UseExtraFieldAllowedValuesList (BIT) Use Predefined List - check to manage the predefined list, when it is checked the Manage button will appear
UseAdvancedCarrierPriceSheet (BIT) Use Advanced Carrier Price Sheet - will this account use the advanced carrier pricing sheet? if yes, check this box and a column called Advanced Spiff SKU will appear in the Carrier Price Sheet
UseAdvancedSPIFFTracking (BIT) Use Advanced SPIFF Tracking - will this account use the advanced SPIFF Tracking? If yes, check this box and a new tab called Advanced SPIFF will appear in your Carrier Price Sheet. This will be linked to the Vendor Account.
UseLowestPrice (BIT) Use Lowest Price - will allow you to specify the lowest price a phone can be sold for per term before a manager override is triggered
EnableVendorSKU (BIT) Enable Vendor SKU - if this is checked, phones will appear twice in the columns in the Price Sheet, once for the SPIFF value and once for the Vendor SKU
CarrierID (UNIQUEIDENTIFIER) Internal identifier for a Carrier in RQ
IsMasterAgentAccount (BIT) A flag to indicate if this is a Master Agent Account
UseCustomGLForVenRebAccPayment (BIT) Use Custom G/L Accounts for Vendor Rebate Account Transactions - if this box is checked you will have the option to select another G/L option that will be for Vendor Rebate Account Transactions
CustomGLAccountIDForVenRebAccPayment (INT) See UseCustomGLForVenRebAccPayment. This field may be empty
LocalizationID (UNIQUEIDENTIFIER) Internal value in RQ

DiscountLevel

[
    {
        "DiscountLevelID": 1,
        "Description": "No Discount"
    }
]
Name Description
DiscountLevelID (INT) Identifier
Description (NVARCHAR(MAX)) Description

Tax

[
    {
        "TaxID": 1,
        "Description": "State of Alabama"
    }
]
Name Description
TaxID (INT) Identifier
Description (NVARCHAR(MAX)) Tax name

EntryType

[
    {
        "EntryTypeID": 1,
        "EntryTypeDescription": "Swiped",
        "Message": "Swiped"
    }
]
Name Description
EntryTypeID (INT) Identifier
EntryTypeDescription (VARCHAR(50)) Description
Message (NVARCHAR(MAX)) Message

CardType

[
    {
        "CardTypeID": 2,
        "FullName": "Mastercard",
        "Mnemonic": "MC",
        "AccountNumberLength": 16,
        "CvvLength": 3
    }
]
Name Description
CardTypeID (INT) Identifier
FullName (VARCHAR(50)) Full card name
Mnemonic (VARCHAR(2)) Card abbreviation
AccountNumberLength (INT) Length of account number
CvvLength (INT) Length of CVV number on card

BillPayProviderID

[
    {
        "ProviderID": 1,
        "ProviderName": "Simplified Bill Payment"
    }
]
Name Description
ProviderID (INT) Identifier
ProviderName (NVARCHAR(50)) Provider Name

REQUESTS

GET Session Information

This request allows you to retrieve information about a Basic access token.

Definition

GET /session?Auth={Auth}

Example Request

GET /session?Auth=vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw
curl -X GET "https://dataconnectdemo.iqmetrix.net/session?Auth=vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw"
static IRestResponse GettingSessionInformation()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/session?Auth=vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw");
    var request = new RestRequest(Method.GET);
     

    

    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 GettingSessionInformation() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/session?Auth=vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw");
     
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/session?Auth=vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw' 

puts response

URI Parameters

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
{
    "access_token": "b0k0dY70N3Vv9jR1b9oEdW9IeT5WIn85WCYFJRo6AiIKLEMBFwNbEQsfeCUeM3gdPA1gAAVxWTJacX8mJyBaGRcFVwQOEV49NgBz",
    "isValid": true,
    "ParentEntityId": 21090,
    "RQEmployeeId": 3494
}

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "access_token": "b0k0dY70N3Vv9jR1b9oEdW9IeT5WIn85WCYFJRo6AiIKLEMBFwNbEQsfeCUeM3gdPA1gAAVxWTJacX8mJyBaGRcFVwQOEV49NgBz",
    "isValid": true,
    "ParentEntityId": 21090,
    "RQEmployeeId": 3494
}

Abandoning a Session

This request allows you to abandon a session.

Definition

GET /session/abandon

Headers

Example Request

GET /session/abandon
Authorization: Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw

curl -X GET "https://dataconnectdemo.iqmetrix.net/session/abandon" -H "Authorization: Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw"
static IRestResponse AbandoningASession()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/session/abandon");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw"); 

    

    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 AbandoningASession() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/session/abandon");
     
    request.addHeader("Authorization", "Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/session/abandon', {
     :'Authorization' => 'Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw',
    } 

puts response

Example Response (Default)

HTTP 200 Content-Type: application/json

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json

Basic Authentication with Platform Credentials

This request allows you to use Platform credentials to obtain an Access Token.

In the Authorization header, place the base 64 encoded form of your username and password prefixed by the word Basic.

For examples, see Basic Authentication

Note that as long as your username and password do not change, the Basic token generated from your username and password will remain the same.

Definition

GET /session

Headers

Example Request

GET /session
Authorization: Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw

curl -X GET "https://dataconnectdemo.iqmetrix.net/session" -H "Authorization: Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw"
static IRestResponse BasicAuthenticationWithPlatformCredentials()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/session");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw"); 

    

    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 BasicAuthenticationWithPlatformCredentials() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/session");
     
    request.addHeader("Authorization", "Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw"); 
    
    return httpClient.execute(request);
}
require 'rest-client'


response = RestClient.get 'https://dataconnectdemo.iqmetrix.net/session', {
     :'Authorization' => 'Basic vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw',
    } 

puts response

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
{
    "access_token": "b0k0dY70N3Vv9jR1b9oEdW9IeT5WIn85WCYFJRo6AiIKLEMBFwNbEQsfeCUeM3gdPA1gAAVxWTJacX8mJyBaGRcFVwQOEV49NgBz",
    "isValid": true,
    "ParentEntityId": 21090,
    "RQEmployeeId": 3494,
    "basic_token": "vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw",
    "PreferredEndpoint": "https://rqdataconnect18.iqmetrix.net"
}

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "access_token": "b0k0dY70N3Vv9jR1b9oEdW9IeT5WIn85WCYFJRo6AiIKLEMBFwNbEQsfeCUeM3gdPA1gAAVxWTJacX8mJyBaGRcFVwQOEV49NgBz",
    "isValid": true,
    "ParentEntityId": 21090,
    "RQEmployeeId": 3494,
    "basic_token": "vRMt17P8rIBWWbVbLzLWjTNyLfvESgA2yfXhze0WZN7HSIl4slGV866p9dSw",
    "PreferredEndpoint": "https://rqdataconnect18.iqmetrix.net"
}

GET Data Connect Request History

Definition

GET /logging/requests?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&isException={isException}&CompanyID={CompanyID}&PartnerID={PartnerID}&CarrierID={CarrierID}

Headers

Example Request

GET /logging/requests?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&isException=false&CompanyID=14146&PartnerID=66&CarrierID=9
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/logging/requests?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&isException=false&CompanyID=14146&PartnerID=66&CarrierID=9" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingDataConnectRequestHistory()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/logging/requests?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&isException=false&CompanyID=14146&PartnerID=66&CarrierID=9");
    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 GettingDataConnectRequestHistory() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/logging/requests?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&isException=false&CompanyID=14146&PartnerID=66&CarrierID=9");
     
    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/logging/requests?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&isException=false&CompanyID=14146&PartnerID=66&CarrierID=9', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[LoggedRequest]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "RequestID": "ba5fbc85-fe5c-fe10-0a4d-add4e13e83ac",
        "CompanyID": 14146,
        "CompanyName": "KENTEL",
        "UserManagerEmployeeID": 280494,
        "UserName": "John.Bates@KENTEL",
        "RQEmployeeID": 5121,
        "ClientIPAddress": "127.0.0.1",
        "DTCreated": "2017-04-05T16:52:41.26",
        "DTCompleted": "2017-04-05T16:56:10.50",
        "Records": 6,
        "Uri": "https://rqdataconnect1.iqmetrix.net/lists/employees",
        "MachineName": "IQ-TEST001",
        "StatusCode": 500,
        "Message": "Column 'DateCreated' is read only.",
        "Origin": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "RequestID": "ba5fbc85-fe5c-fe10-0a4d-add4e13e83ac",
            "CompanyID": 14146,
            "CompanyName": "KENTEL",
            "UserManagerEmployeeID": 280494,
            "UserName": "John.Bates@KENTEL",
            "RQEmployeeID": 5121,
            "ClientIPAddress": "127.0.0.1",
            "DTCreated": "2017-04-05T16:52:41.26",
            "DTCompleted": "2017-04-05T16:56:10.50",
            "Records": 6,
            "Uri": "https://rqdataconnect1.iqmetrix.net/lists/employees",
            "MachineName": "IQ-TEST001",
            "StatusCode": 500,
            "Message": "Column 'DateCreated' is read only.",
            "Origin": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <RequestID>ba5fbc85-fe5c-fe10-0a4d-add4e13e83ac</RequestID>
    <CompanyID>14146</CompanyID>
    <CompanyName>KENTEL</CompanyName>
    <UserManagerEmployeeID>280494</UserManagerEmployeeID>
    <UserName>John.Bates@KENTEL</UserName>
    <RQEmployeeID>5121</RQEmployeeID>
    <ClientIPAddress>127.0.0.1</ClientIPAddress>
    <DTCreated>2017-04-05T16:52:41.26</DTCreated>
    <DTCompleted>2017-04-05T16:56:10.50</DTCompleted>
    <Records>6</Records>
    <Uri>https://rqdataconnect1.iqmetrix.net/lists/employees</Uri>
    <MachineName>IQ-TEST001</MachineName>
    <StatusCode>500</StatusCode>
    <Message>Column 'DateCreated' is read only.</Message>
    <Origin></Origin>
  </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
RequestID,CompanyID,CompanyName,UserManagerEmployeeID,UserName,RQEmployeeID,ClientIPAddress,DTCreated,DTCompleted,Records,Uri,MachineName,StatusCode,Message,Origin
ba5fbc85-fe5c-fe10-0a4d-add4e13e83ac,14146,KENTEL,280494,John.Bates@KENTEL,5121,127.0.0.1,2017-04-05T16:52:41.26,2017-04-05T16:56:10.50,6,https://rqdataconnect1.iqmetrix.net/lists/employees,IQ-TEST001,500,Column 'DateCreated' is read only.,

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 Employees

Definition

GET /lists/employees

Headers

Example Request

GET /lists/employees
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/employees" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingEmployees()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/employees");
    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 GettingEmployees() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/employees");
     
    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/lists/employees', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "EmployeeID": 22,
        "EmployeeEntityID": 44567,
        "Name": "Jim Bob",
        "First_Name": "Jim",
        "Last_Name": "Bob"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "EmployeeID": 22,
            "EmployeeEntityID": 44567,
            "Name": "Jim Bob",
            "First_Name": "Jim",
            "Last_Name": "Bob"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <EmployeeID>22</EmployeeID>
    <EmployeeEntityID>44567</EmployeeEntityID>
    <Name>Jim Bob</Name>
    <First_Name>Jim</First_Name>
    <Last_Name>Bob</Last_Name>
  </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
EmployeeID,EmployeeEntityID,Name,First_Name,Last_Name
22,44567,Jim Bob,Jim,Bob

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 Category Numbers

Definition

GET /lists/categorynumber

Headers

Example Request

GET /lists/categorynumber
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/categorynumber" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingCategoryNumbers()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/categorynumber");
    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 GettingCategoryNumbers() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/categorynumber");
     
    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/lists/categorynumber', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Array[CategoryNumber]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": "10101",
        "Description": "Rate Plans",
        "CategoryPath": " >> Activations",
        "ParentID": "1010"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": "10101",
            "Description": "Rate Plans",
            "CategoryPath": " >> Activations",
            "ParentID": "1010"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>10101</ID>
    <Description>Rate Plans</Description>
    <CategoryPath> >> Activations</CategoryPath>
    <ParentID>1010</ParentID>
  </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
ID,Description,CategoryPath,ParentID
10101,Rate Plans, >> Activations,1010

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 Language Codes

Definition

GET /lists/languages

Headers

Example Request

GET /lists/languages
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/languages" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingLanguageCodes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/languages");
    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 GettingLanguageCodes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/languages");
     
    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/lists/languages', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": "en-us"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": "en-us"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>en-us</ID>
  </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
ID
en-us

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 Products in RQ

Definition

GET /lists/productidentifier

Headers

Example Request

GET /lists/productidentifier
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/productidentifier" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingProductsInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/productidentifier");
    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 GettingProductsInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/productidentifier");
     
    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/lists/productidentifier', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": "ASCLMO000001",
        "Description": "HC Samsung U340"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": "ASCLMO000001",
            "Description": "HC Samsung U340"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>ASCLMO000001</ID>
    <Description>HC Samsung U340</Description>
  </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
ID,Description
ASCLMO000001,HC Samsung U340

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 Reason Codes

Definition

GET /lists/reasoncode

Headers

Example Request

GET /lists/reasoncode
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/reasoncode" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingReasonCodes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/reasoncode");
    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 GettingReasonCodes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/reasoncode");
     
    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/lists/reasoncode', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Array[ReasonCode]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": "1",
        "Description": "Write Off"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": "1",
            "Description": "Write Off"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>1</ID>
    <Description>Write Off</Description>
  </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
ID,Description
1,Write Off

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 Report Levels in RQ

This request will return a list of hierarchical levels in your company tree in RQ.

To learn more about Locations in RQ, see Location Setup.

Definition

GET /lists/forwhoid

Headers

Example Request

GET /lists/forwhoid
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/forwhoid" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingReportLevelsInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/forwhoid");
    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 GettingReportLevelsInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/forwhoid");
     
    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/lists/forwhoid', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": "1",
        "Description": "Company"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": "1",
            "Description": "Company"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>1</ID>
    <Description>Company</Description>
  </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
ID,Description
1,Company

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 Nodes By Location Type

This request will return a list of locations in RQ a report can be restricted to.

Definition

GET /lists/forwhoids?ForWho={ForWho}

Headers

Example Request

GET /lists/forwhoids?ForWho=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/forwhoids?ForWho=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingNodesByLocationType()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/forwhoids?ForWho=1");
    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 GettingNodesByLocationType() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/forwhoids?ForWho=1");
     
    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/lists/forwhoids?ForWho=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": 1,
        "Column1": "KENTEL Corp",
        "EntityID": 11432
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": 1,
            "Column1": "KENTEL Corp",
            "EntityID": 11432
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>1</ID>
    <Column1>KENTEL Corp</Column1>
    <EntityID>11432</EntityID>
  </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
ID,Column1,EntityID
1,KENTEL Corp,11432

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 a List of Manufacturers in RQ

Definition

GET /lists/manufactureid

Headers

Example Request

GET /lists/manufactureid
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/manufactureid" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingAListOfManufacturersInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/manufactureid");
    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 GettingAListOfManufacturersInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/manufactureid");
     
    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/lists/manufactureid', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": "9",
        "Description": "LG"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": "9",
            "Description": "LG"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>9</ID>
    <Description>LG</Description>
  </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
ID,Description
9,LG

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 A List of Stores in RQ

Definition

GET /lists/stores

Headers

Example Request

GET /lists/stores
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/stores" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingAListOfStoresInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/stores");
    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 GettingAListOfStoresInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/stores");
     
    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/lists/stores', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "StoreID": 1188,
        "LocationEntityID": 453,
        "StoreName": "Altera Kiosk"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "StoreID": 1188,
            "LocationEntityID": 453,
            "StoreName": "Altera Kiosk"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <StoreID>1188</StoreID>
    <LocationEntityID>453</LocationEntityID>
    <StoreName>Altera Kiosk</StoreName>
  </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
StoreID,LocationEntityID,StoreName
1188,453,Altera Kiosk

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 a List of Coupons in RQ

Definition

GET /lists/CouponID?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/CouponID?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/CouponID?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingAListOfCouponsInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/CouponID?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 GettingAListOfCouponsInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/CouponID?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/lists/CouponID?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[Coupon]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CouponID": 1144,
        "CouponName": "TEST2"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CouponID": 1144,
            "CouponName": "TEST2"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CouponID>1144</CouponID>
    <CouponName>TEST2</CouponName>
  </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
CouponID,CouponName
1144,TEST2

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 a List of Groups in RQ

Definition

GET /lists/GroupID

Headers

Example Request

GET /lists/GroupID
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/GroupID" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingAListOfGroupsInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/GroupID");
    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 GettingAListOfGroupsInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/GroupID");
     
    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/lists/GroupID', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Array[Group]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "GroupID": 4,
        "GroupName": "100% (35% GP)"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "GroupID": 4,
            "GroupName": "100% (35% GP)"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <GroupID>4</GroupID>
    <GroupName>100% (35% GP)</GroupName>
  </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
GroupID,GroupName
4,100% (35% GP)

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 a List of Carriers in RQ

Definition

GET /lists/CarrierSIP?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/CarrierSIP?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/CarrierSIP?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingAListOfCarriersInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/CarrierSIP?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 GettingAListOfCarriersInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/CarrierSIP?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/lists/CarrierSIP?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CarrierID": 10,
        "CarrierName": "Nextel"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CarrierID": 10,
            "CarrierName": "Nextel"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CarrierID>10</CarrierID>
    <CarrierName>Nextel</CarrierName>
  </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
CarrierID,CarrierName
10,Nextel

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 Financing Types

Definition

GET /lists/FinancingDetailID?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/FinancingDetailID?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/FinancingDetailID?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingFinancingTypes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/FinancingDetailID?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 GettingFinancingTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/FinancingDetailID?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/lists/FinancingDetailID?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "FinancingDetailID": 19,
        "FinancingDetailName": "Import"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "FinancingDetailID": 19,
            "FinancingDetailName": "Import"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <FinancingDetailID>19</FinancingDetailID>
    <FinancingDetailName>Import</FinancingDetailName>
  </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
FinancingDetailID,FinancingDetailName
19,Import

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 Store Types

Definition

GET /lists/StoreTypes?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/StoreTypes?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/StoreTypes?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingStoreTypes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/StoreTypes?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 GettingStoreTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/StoreTypes?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/lists/StoreTypes?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[StoreType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Type": 3,
        "StoreTypeName": "Kiosk"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Type": 3,
            "StoreTypeName": "Kiosk"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Type>3</Type>
    <StoreTypeName>Kiosk</StoreTypeName>
  </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
Type,StoreTypeName
3,Kiosk

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 Location Types

Definition

GET /lists/LocationType

Headers

Example Request

GET /lists/LocationType
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/LocationType" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingLocationTypes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/LocationType");
    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 GettingLocationTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/LocationType");
     
    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/lists/LocationType', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Array[LocationType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Type": "Channel"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Type": "Channel"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Type>Channel</Type>
  </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
Type
Channel

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 Location Ids

This request allows you to get a list of identifiers for a specific LocationType within a company.

For example, /lists/LocationIDs?LocationType=Region will return a list of all Regions in the company including the RQ identifier and associated CompanyTreeNode identifier.

Definition

GET /lists/LocationIDs?LocationType={LocationType}&LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/LocationIDs?LocationType=Company&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/LocationIDs?LocationType=Company&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingLocationIds()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/LocationIDs?LocationType=Company&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 GettingLocationIds() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/LocationIDs?LocationType=Company&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/lists/LocationIDs?LocationType=Company&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[RQCompanyTreeNode]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ID": 0,
        "Description": "KENTEL Corp",
        "EntityID": 14146
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ID": 0,
            "Description": "KENTEL Corp",
            "EntityID": 14146
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ID>0</ID>
    <Description>KENTEL Corp</Description>
    <EntityID>14146</EntityID>
  </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
ID,Description,EntityID
0,KENTEL Corp,14146

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 a List of Vendors in RQ

Definition

GET /lists/VendorID?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/VendorID?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/VendorID?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingAListOfVendorsInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/VendorID?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 GettingAListOfVendorsInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/VendorID?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/lists/VendorID?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[VendorID]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "VendorID": 1,
        "VendorName": "A.C.P"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "VendorID": 1,
            "VendorName": "A.C.P"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <VendorID>1</VendorID>
    <VendorName>A.C.P</VendorName>
  </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
VendorID,VendorName
1,A.C.P

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 Product Types

Definition

GET /lists/ProductType

Headers

Example Request

GET /lists/ProductType
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/ProductType" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingProductTypes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/ProductType");
    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 GettingProductTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/ProductType");
     
    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/lists/ProductType', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Array[ProductType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ProductTypeID": 0,
        "ProductType": "Regular Global Product"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ProductTypeID": 0,
            "ProductType": "Regular Global Product"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ProductTypeID>0</ProductTypeID>
    <ProductType>Regular Global Product</ProductType>
  </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
ProductTypeID,ProductType
0,Regular Global Product

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 Non Sellable Reason Codes

Definition

GET /lists/NonSellableReasonCode?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/NonSellableReasonCode?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/NonSellableReasonCode?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingNonSellableReasonCodes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/NonSellableReasonCode?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 GettingNonSellableReasonCodes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/NonSellableReasonCode?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/lists/NonSellableReasonCode?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[NonSellableReasonCode]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ReasonCode": "c5473733-e030-83cf-7a9f-4e95a3c27efa",
        "ReasonCodeDescription": "Scratched"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ReasonCode": "c5473733-e030-83cf-7a9f-4e95a3c27efa",
            "ReasonCodeDescription": "Scratched"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ReasonCode>c5473733-e030-83cf-7a9f-4e95a3c27efa</ReasonCode>
    <ReasonCodeDescription>Scratched</ReasonCodeDescription>
  </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
ReasonCode,ReasonCodeDescription
c5473733-e030-83cf-7a9f-4e95a3c27efa,Scratched

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 Sales Opportunity Types

Definition

GET /lists/SalesOpportunityType?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/SalesOpportunityType?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/SalesOpportunityType?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingSalesOpportunityTypes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/SalesOpportunityType?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 GettingSalesOpportunityTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/SalesOpportunityType?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/lists/SalesOpportunityType?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[SalesOpportunityType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "SalesOpportunityTypeID": 2,
        "Description": "New Activation"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "SalesOpportunityTypeID": 2,
            "Description": "New Activation"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <SalesOpportunityTypeID>2</SalesOpportunityTypeID>
    <Description>New Activation</Description>
  </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
SalesOpportunityTypeID,Description
2,New Activation

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 Service Types

Definition

GET /lists/ServiceTypes?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/ServiceTypes?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/ServiceTypes?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingServiceTypes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/ServiceTypes?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 GettingServiceTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/ServiceTypes?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/lists/ServiceTypes?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ServiceType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ServiceTypeID": 1,
        "Description": "newer"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ServiceTypeID": 1,
            "Description": "newer"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ServiceTypeID>1</ServiceTypeID>
    <Description>newer</Description>
  </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
ServiceTypeID,Description
1,newer

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 Payment Types in RQ

Definition

GET /lists/PaymentTypeIDs?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/PaymentTypeIDs?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/PaymentTypeIDs?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingPaymentTypesInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/PaymentTypeIDs?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 GettingPaymentTypesInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/PaymentTypeIDs?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/lists/PaymentTypeIDs?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[PaymentTypeData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "PaymentTypeID": 0,
        "PaymentName": "Account"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "PaymentTypeID": 0,
            "PaymentName": "Account"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <PaymentTypeID>0</PaymentTypeID>
    <PaymentName>Account</PaymentName>
  </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
PaymentTypeID,PaymentName
0,Account

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 GL Source Types in RQ

Definition

GET /lists/GL_SourceType?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/GL_SourceType?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/GL_SourceType?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingGlSourceTypesInRq()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/GL_SourceType?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 GettingGlSourceTypesInRq() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/GL_SourceType?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/lists/GL_SourceType?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[GLSourceType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "GL_SourceType": 0,
        "GP_SourceTypeName": "Opening Balance"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "GL_SourceType": 0,
            "GP_SourceTypeName": "Opening Balance"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <GL_SourceType>0</GL_SourceType>
    <GP_SourceTypeName>Opening Balance</GP_SourceTypeName>
  </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
GL_SourceType,GP_SourceTypeName
0,Opening Balance

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 Vendor Accounts

Definition

GET /lists/VendorAccountID?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/VendorAccountID?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/VendorAccountID?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingVendorAccounts()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/VendorAccountID?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 GettingVendorAccounts() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/VendorAccountID?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/lists/VendorAccountID?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[VendorAccount]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "VendorAccountID": 1,
        "VendorID": 18,
        "EmployeeID": 1,
        "StoreID": 13,
        "AccountName": "Verizon 2",
        "Comments": "",
        "DateCreated": "2010-06-30T07:45:08.197",
        "GLAccountID1": 1004,
        "RowTimeStamp": "AAAAAAA07EE=",
        "RequireSOCcode": 1,
        "ForcedSOCcodeLength": 10,
        "ForceSOCcodeLength": 1,
        "RequireExtraField": true,
        "ForcedExtraFieldLength": 5,
        "ForceExtraFieldLength": false,
        "ExtraFieldDescriptionID": "817e1a3d-2fb9-3c0e-cbde-5ec32cce8f3d",
        "UseExtraFieldAllowedValuesList": true,
        "UseAdvancedCarrierPriceSheet": true,
        "UseAdvancedSPIFFTracking": false,
        "UseLowestPrice": false,
        "EnableVendorSKU": false,
        "CarrierID": "77527370-cfb1-ecaf-9c57-0a7fe94ae745",
        "IsMasterAgentAccount": false,
        "UseCustomGLForVenRebAccPayment": false,
        "CustomGLAccountIDForVenRebAccPayment": 0,
        "LocalizationID": "0d653e99-53dc-f6db-3f78-77ed09fbf00b"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "VendorAccountID": 1,
            "VendorID": 18,
            "EmployeeID": 1,
            "StoreID": 13,
            "AccountName": "Verizon 2",
            "Comments": "",
            "DateCreated": "2010-06-30T07:45:08.197",
            "GLAccountID1": 1004,
            "RowTimeStamp": "AAAAAAA07EE=",
            "RequireSOCcode": 1,
            "ForcedSOCcodeLength": 10,
            "ForceSOCcodeLength": 1,
            "RequireExtraField": true,
            "ForcedExtraFieldLength": 5,
            "ForceExtraFieldLength": false,
            "ExtraFieldDescriptionID": "817e1a3d-2fb9-3c0e-cbde-5ec32cce8f3d",
            "UseExtraFieldAllowedValuesList": true,
            "UseAdvancedCarrierPriceSheet": true,
            "UseAdvancedSPIFFTracking": false,
            "UseLowestPrice": false,
            "EnableVendorSKU": false,
            "CarrierID": "77527370-cfb1-ecaf-9c57-0a7fe94ae745",
            "IsMasterAgentAccount": false,
            "UseCustomGLForVenRebAccPayment": false,
            "CustomGLAccountIDForVenRebAccPayment": 0,
            "LocalizationID": "0d653e99-53dc-f6db-3f78-77ed09fbf00b"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <VendorAccountID>1</VendorAccountID>
    <VendorID>18</VendorID>
    <EmployeeID>1</EmployeeID>
    <StoreID>13</StoreID>
    <AccountName>Verizon 2</AccountName>
    <Comments></Comments>
    <DateCreated>2010-06-30T07:45:08.197</DateCreated>
    <GLAccountID1>1004</GLAccountID1>
    <RowTimeStamp>AAAAAAA07EE=</RowTimeStamp>
    <RequireSOCcode>1</RequireSOCcode>
    <ForcedSOCcodeLength>10</ForcedSOCcodeLength>
    <ForceSOCcodeLength>1</ForceSOCcodeLength>
    <RequireExtraField>true</RequireExtraField>
    <ForcedExtraFieldLength>5</ForcedExtraFieldLength>
    <ForceExtraFieldLength>false</ForceExtraFieldLength>
    <ExtraFieldDescriptionID>817e1a3d-2fb9-3c0e-cbde-5ec32cce8f3d</ExtraFieldDescriptionID>
    <UseExtraFieldAllowedValuesList>true</UseExtraFieldAllowedValuesList>
    <UseAdvancedCarrierPriceSheet>true</UseAdvancedCarrierPriceSheet>
    <UseAdvancedSPIFFTracking>false</UseAdvancedSPIFFTracking>
    <UseLowestPrice>false</UseLowestPrice>
    <EnableVendorSKU>false</EnableVendorSKU>
    <CarrierID>77527370-cfb1-ecaf-9c57-0a7fe94ae745</CarrierID>
    <IsMasterAgentAccount>false</IsMasterAgentAccount>
    <UseCustomGLForVenRebAccPayment>false</UseCustomGLForVenRebAccPayment>
    <CustomGLAccountIDForVenRebAccPayment>0</CustomGLAccountIDForVenRebAccPayment>
    <LocalizationID>0d653e99-53dc-f6db-3f78-77ed09fbf00b</LocalizationID>
  </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
VendorAccountID,VendorID,EmployeeID,StoreID,AccountName,Comments,DateCreated,GLAccountID1,RowTimeStamp,RequireSOCcode,ForcedSOCcodeLength,ForceSOCcodeLength,RequireExtraField,ForcedExtraFieldLength,ForceExtraFieldLength,ExtraFieldDescriptionID,UseExtraFieldAllowedValuesList,UseAdvancedCarrierPriceSheet,UseAdvancedSPIFFTracking,UseLowestPrice,EnableVendorSKU,CarrierID,IsMasterAgentAccount,UseCustomGLForVenRebAccPayment,CustomGLAccountIDForVenRebAccPayment,LocalizationID
1,18,1,13,Verizon 2,,2010-06-30T07:45:08.197,1004,AAAAAAA07EE=,1,10,1,true,5,false,817e1a3d-2fb9-3c0e-cbde-5ec32cce8f3d,true,true,false,false,false,77527370-cfb1-ecaf-9c57-0a7fe94ae745,false,false,0,0d653e99-53dc-f6db-3f78-77ed09fbf00b

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 Discount Levels

Definition

GET /lists/DiscountLevelID?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/DiscountLevelID?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/DiscountLevelID?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingDiscountLevels()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/DiscountLevelID?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 GettingDiscountLevels() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/DiscountLevelID?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/lists/DiscountLevelID?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[DiscountLevel]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "DiscountLevelID": 1,
        "Description": "No Discount"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "DiscountLevelID": 1,
            "Description": "No Discount"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <DiscountLevelID>1</DiscountLevelID>
    <Description>No Discount</Description>
  </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
DiscountLevelID,Description
1,No Discount

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 Taxes

Definition

GET /lists/TaxID?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/TaxID?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/TaxID?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTaxes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/TaxID?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 GettingTaxes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/TaxID?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/lists/TaxID?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[Tax]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "TaxID": 1,
        "Description": "State of Alabama"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "TaxID": 1,
            "Description": "State of Alabama"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <TaxID>1</TaxID>
    <Description>State of Alabama</Description>
  </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
TaxID,Description
1,State of Alabama

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 Entry Types

Definition

GET /lists/entrytypes?LanguageCode={LanguageCode}

Headers

Example Request

GET /lists/entrytypes?LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/entrytypes?LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingEntryTypes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/entrytypes?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 GettingEntryTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/entrytypes?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/lists/entrytypes?LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[EntryType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "EntryTypeID": 1,
        "EntryTypeDescription": "Swiped",
        "Message": "Swiped"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "EntryTypeID": 1,
            "EntryTypeDescription": "Swiped",
            "Message": "Swiped"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <EntryTypeID>1</EntryTypeID>
    <EntryTypeDescription>Swiped</EntryTypeDescription>
    <Message>Swiped</Message>
  </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
EntryTypeID,EntryTypeDescription,Message
1,Swiped,Swiped

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 Card Types

Definition

GET /lists/cardtypes

Headers

Example Request

GET /lists/cardtypes
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/cardtypes" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingCardTypes()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/cardtypes");
    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 GettingCardTypes() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/cardtypes");
     
    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/lists/cardtypes', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Array[CardType]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CardTypeID": 2,
        "FullName": "Mastercard",
        "Mnemonic": "MC",
        "AccountNumberLength": 16,
        "CvvLength": 3
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CardTypeID": 2,
            "FullName": "Mastercard",
            "Mnemonic": "MC",
            "AccountNumberLength": 16,
            "CvvLength": 3
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CardTypeID>2</CardTypeID>
    <FullName>Mastercard</FullName>
    <Mnemonic>MC</Mnemonic>
    <AccountNumberLength>16</AccountNumberLength>
    <CvvLength>3</CvvLength>
  </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
CardTypeID,FullName,Mnemonic,AccountNumberLength,CvvLength
2,Mastercard,MC,16,3

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 Bill Pay Provider IDs

Definition

GET /lists/BillPayProviderID

Headers

Example Request

GET /lists/BillPayProviderID
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/lists/BillPayProviderID" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingBillPayProviderIds()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/lists/BillPayProviderID");
    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 GettingBillPayProviderIds() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/lists/BillPayProviderID");
     
    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/lists/BillPayProviderID', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

Response Parameters

Array[BillPayProviderID]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ProviderID": 1,
        "ProviderName": "Simplified Bill Payment"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ProviderID": 1,
            "ProviderName": "Simplified Bill Payment"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ProviderID>1</ProviderID>
    <ProviderName>Simplified Bill Payment</ProviderName>
  </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
ProviderID,ProviderName
1,Simplified Bill Payment

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
HTTP 503 Maintenance The requested data is currently undergoing scheduled maintenance, please try again after 12:00PM UTC
Was this page helpful?