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.

Report List

For a complete list of reports in Data Connect, see Report List.

ENDPOINTS

RESOURCES

ActivityTrackingReportData

[
    {
        "ActivityID": 123000,
        "CustomerID": 99518,
        "DateCreated": "2015-11-23T14:12:04.16",
        "EmployeeName": "iQmetrix User",
        "Username": "iqmetrix.user@kentel.com",
        "StoreName": "84 West",
        "AssignedToEmployeeName": "",
        "AssignedToUsername": "",
        "ActivityType": "Call - inbound",
        "CustomerName": "John Bates",
        "ContactName": "John Bates",
        "ContactNumber": "5555555555",
        "CellNumber": "5555555555",
        "Description": "",
        "Status": 0,
        "DateClosed": "2015-11-23T14:12:04.16"
    }
]
Name Description
ActivityID (INT) Identifier of an Activity in RQ
CustomerID (INT) Identifier for a customer in RQ
DateCreated (DateTime) Created On - date and time the activity was created
EmployeeName (VARCHAR(51)) Created By - employee who created the activity
Username (VARCHAR(51)) Created By Username - username of the employee who created the activity
StoreName (VARCHAR(MAX)) Location - defaults to the employee’s logged in location but can be edited in the activity screen
AssignedToEmployeeName (VARCHAR(51)) Assigned To - defaults to the employee who created the activity but can be reassigned
AssignedToUsername (VARCHAR(51)) Assigned To Username - username of the employee the activity is assigned to
ActivityType (NVARCHAR(MAX)) Type - type selected from the list of activity types
CustomerName (VARCHAR(152)) Customer - customer to whom the activity is assigned
ContactName (VARCHAR(100)) Contact - defaults to the customer but can be edited in the activity screen
ContactNumber (VARCHAR(50)) Contact # - defaults to the customer’s information but can be edited in the activity screen
CellNumber (VARCHAR(200)) Cell # - defaults to the customer’s information but can be edited in the activity screen
Description (NVARCHAR(MAX)) Description - this is the kind of activity, selected from a drop-down list or typed
Status (TINYINT) Status - activity can be Open, Pending, Completed or Cancelled
DateClosed (DateTime) Completed On - date and time the activity was completed

CustomerContactStatusReportData

[
    {
        "CustomerID": 134945,
        "CustomerName": "John Bates",
        "DateCreated": "2017-04-07T10:37:27.007",
        "ContactNumber": "",
        "Email": "test@example.com",
        "Address": "",
        "Address2": "",
        "City": "Georgetown",
        "Province": "",
        "PostalCode": "",
        "Country": "Argentina",
        "DoNotCall": false,
        "DoNotEmail": true,
        "DoNotPostOfficeMail": false,
        "TypeOfCustomer": "Individual"
    }
]
Name Description
CustomerID (INT) Identifier for a customer in RQ
CustomerName (VARCHAR(200)) Customer - name on the customer profile
DateCreated (DateTime) Created Date
ContactNumber (VARCHAR(50)) Contact # - this is the Primary Phone number on the customer’s profile
Email (VARCHAR(200)) Email - may be blank, if so, the context menu will not have the Email Customer option
Address (VARCHAR(50)) Address - first line of the address in their profile
Address2 (VARCHAR(50)) Address - first line of the address in their profile
City (VARCHAR(50)) City
Province (VARCHAR(50)) Province/State
PostalCode (VARCHAR(15)) Postal/Zip code
Country (VARCHAR(50)) Country
DoNotCall (BIT) No Calls - checked if the customer has requested No Phone Calls or Do not contact, in the Marketing Permissions section of their profile
DoNotEmail (BIT) Do Not Email - checked if the customer has requested No Email or Do not contact, in the Marketing Permissions section of their profile
DoNotPostOfficeMail (BIT) No Mail - checked if the customer has requested No Direct Mail or Do not contact, in the Marketing Permissions section of their profile
TypeOfCustomer (VARCHAR(50)) Customer Type - either a Company or an Individual

CustomerListReportData

[
    {
        "Address": "12 Hello St.",
        "Address2": "n/a",
        "BillingAccountNumber": "",
        "City": "Fargo",
        "ContactNumber": "5555555555",
        "ContactTypeName": "",
        "Country": "United States",
        "CustomerCompanyName": "KENTEL",
        "CustomerFirstName": "Carrie",
        "CustomerID": 2108754,
        "CustomerLastName": "Madison",
        "DateCreated": "2016-01-26T20:55:53.227",
        "DeclineToProvideEmail": false,
        "Email": "carry@test.iq",
        "EmployeeName": "iQmetrix Employee",
        "EmployeeNameAssignedTo": "iQmetrix Employee",
        "IndustryTypeName": "",
        "MultiLevelPriceID": 1,
        "NumberOfActivations": 0,
        "PositionTypeName": "",
        "PostalCode": "90123",
        "Province": "ND",
        "TracPointMemberNumber": "C2981754hduw",
        "TypeOfCustomer": 3,
        "VIPCustomer": 0
    }
]
Name Description
Address (VARCHAR(50)) Address - first line of the address
Address2 (VARCHAR(50)) Address 2 - second line of the address, if necessary
BillingAccountNumber (NVARCHAR(MAX)) BAN -  if your company uses BAN you will enter it in the Customer profile and it will show here
City (VARCHAR(50)) City - customer’s city
ContactNumber (VARCHAR(200)) Contact # - the number that is selected on the customer’s profile, it can be any of the number options there
ContactTypeName (NVARCHAR(MAX)) Contact Type - as defined in General Customer Setup and assigned in the Custom Fields section on the customer’s profile
Country (VARCHAR(50)) Country - customer’s country
CustomerCompanyName (VARCHAR(50)) Company Name - may be blank depending on the kind of customer
CustomerFirstName (VARCHAR(50)) First Name - may be blank depending on the kind of customer
CustomerID (INT) Identifier for a Customer in RQ
CustomerLastName (VARCHAR(50)) Last Name - may be blank depending on the kind of customer
DateCreated (DateTime) Created On - day and time the customer’s profile was created
DeclineToProvideEmail (BIT) Decline Email - the option for customers to decline email
Email (VARCHAR(200)) Email - may be blank, if so, the context menu will not have the Email Customer option
EmployeeName (VARCHAR(51)) Created By - employee who created the profile
EmployeeNameAssignedTo (VARCHAR(51)) Assigned To - may be blank if the customer has not been assigned to an employee
IndustryTypeName (NVARCHAR(MAX)) Industry Type - as defined in General Customer Setup and assigned in the Custom Fields section on the customer’s profile
MultiLevelPriceID (INT) Pricing Group - as defined in Multi-Level Pricing - Setup and assigned in the Discount Level field in the More Information section on the customer’s profile
NumberOfActivations (INT) # of Activations - number of Activations the customer has completed as recorded in RQ
PositionTypeName (NVARCHAR(MAX)) Position Type - as defined in General Customer Setup and assigned in the Custom Fields section on the customer’s profile
PostalCode (VARCHAR(15)) Zip/Postal Code - zip code (USA) or postal code (Canada)
Province (VARCHAR(50)) State/Province - customer’s state or province
TracPointMemberNumber (VARCHAR(30)) Member # - this number is automatically generated when a new customer is created
TypeOfCustomer (INT) Type Of Customer - 0 for Company, or 3 for Individual
VIPCustomer (TINYINT) VIP Customer - will be checked if this is a VIP Customer

MarketingSummaryReportData

[
    {
        "SaleInvoiceID": 132500,
        "DateCreated": "2017-01-04T10:02:43.313",
        "InvoiceIDByStore": "84WEAIN17153",
        "StoreName": "84 West",
        "CustomerName": "No Customer",
        "MarketingTypeName": "First Type",
        "MarketingTypeStartDate": "2016-05-31T00:00:00",
        "MarketingTypeStopDate": "2016-10-31T00:00:00",
        "Status": "New",
        "Count": 1
    }
]
Name Description
SaleInvoiceID (INT) Internal identifier for an Invocie in RQ
DateCreated (DateTime) Created On - date the Marketing Type was applied to the invoice
InvoiceIDByStore (VARCHAR(14)) Invoice # - number of the invoice
StoreName (NVARCHAR(MAX)) Location - where the invoice was tendered
CustomerName (VARCHAR(151)) Customer - name of the customer
MarketingTypeName (NVARCHAR(MAX)) Type - Marketing Type
MarketingTypeStartDate (DateTime) Start Date - start date of the Marketing Type
MarketingTypeStopDate (DateTime) End Date - end date of the Marketing Type, blank if not set
Status (VARCHAR(6)) Status - either a New or a Repeat
Count (INT) Qty - total for the date range

ServiceRequestHistoryReportData

[
    {
        "ServiceRequestID": 106,
        "ServiceRequestIDByStore": "TOTLISR5",
        "StoreName": "84 West",
        "CustomerID1": 124051,
        "CustomerName1": "John Bates",
        "CustomerName2": "",
        "EmployeeName1": "iQmetrix Employee",
        "Username1": "iQmetrix.Employee",
        "EmployeeName2": "",
        "EmployeeName3": "",
        "EmployeeName4": "iQmetrix Employee",
        "ContactName": "John Bates",
        "ContactNumber": "(555)555-5555",
        "Priority": 2,
        "FollowUpAfter": 0,
        "Description": "",
        "DateCreated": "2017-01-04T10:07:34.953",
        "DateClosed": "2017-01-04T10:07:34.953",
        "ServiceType": 2,
        "Status": 0,
        "SubStatus": 0,
        "WaybillNumber": "",
        "ShippingMethod": "Regular",
        "ShippingStatus": 0,
        "DateShipped": "2017-01-04T00:00:00",
        "DateReceived": "2017-01-04T10:07:34.953",
        "ShippingETA": "2017-01-04T00:00:00",
        "ShippingComments": "",
        "InternalComments": "",
        "ExternalComments": ""
    }
]
Name Description
ServiceRequestID (INT) Identifier for a Service Request in RQ
ServiceRequestIDByStore (VARCHAR(14)) Service Request # - service request number assigned by RQ
StoreName (NVARCHAR(MAX)) Location - name of the location where the service request was made
CustomerID1 (INT) Identifier for a Customer in RQ
CustomerName1 (VARCHAR(151)) Customer - name of the customer as entered on their profile
CustomerName2 (VARCHAR(151)) Linked To - name of the company or another customer in your database with a link to this customer
EmployeeName1 (VARCHAR(51)) Created By - name of the employee logged into RQ when the service request was created
Username1 (VARCHAR(51)) Username - username of the employee logged into RQ when the service request was created but any employee can be assigned to the service request
EmployeeName2 (VARCHAR(51)) Employee name
EmployeeName3 (VARCHAR(51)) Employee name
EmployeeName4 (VARCHAR(51)) Employee name
ContactName (VARCHAR(100)) Contact - name of the contact for the service request
ContactNumber (VARCHAR(50)) Contact # - telephone number for the contact, this defaults to the number on their profile but can be edited in the service request without changing the profile
Priority (TINYINT) Priority - notes the priority for this service request as Critical, High, Medium, Low or Question
FollowUpAfter (TINYINT) Follow Up After - indicates when follow up is due
Description (NVARCHAR(MAX)) Description - description of the service request
DateCreated (DateTime) Created On - date and time the service request was created
DateClosed (DateTime) Closed On - date and time the service request was closed
ServiceType (TINYINT) Service type
Status (TINYINT) Status - indicates that the service request is Open, Pending, Completed or Cancelled
SubStatus (TINYINT) Sub Status - indicates that the service request is In Progress, Unassigned, Not an issue, Waiting for Customer or Work completed
WaybillNumber (VARCHAR(50)) Way Bill # - tracking number provided by shipping company, e.g. UPS, Purolator, etc.
ShippingMethod (VARCHAR(50)) Shipping Method - shipping method for this service request
ShippingStatus (TINYINT) Shipping Status - shipping status for this service request
DateShipped (DateTime) Shipped On - date the product was shipped
DateReceived (DateTime) Received On - date the product was received
ShippingETA (DateTime) Shipping ETA - estimated time of arrival
ShippingComments (VARCHAR(1000)) Shipping Comments - any comments relating to shipping
InternalComments (VARCHAR(5000)) Internal Comments - internal comments
ExternalComments (VARCHAR(5000)) External Comments - comments that the customer or other external person(s) may make

ServiceManagerReportData

[
    {
        "ServiceID": 17,
        "CustomerID": 125159,
        "ServiceTypeName": "123",
        "SaleInvoiceID": 121863,
        "SaleInvoiceIDByStore": "TALLAIN7263",
        "ProductIdentifier": "ZWRFNS000008",
        "Status": "Disabled",
        "UsersName": "Kobi Labok",
        "Customer": "Emma Stone",
        "TrackingNumber": "56789012345678901234567890",
        "ActivationDate": "2015-02-23T00:00:00",
        "ExpiryDate": "2015-02-26T00:00:00",
        "ResidualStart": "2015-02-26T00:00:00",
        "ResidualStop": "2015-02-26T00:00:00",
        "AverageBill": 0,
        "RatePlan": "1",
        "CompletedDate": "2015-02-23T17:12:50.027",
        "Completed": true,
        "OriginalExpiryDate": "2015-02-28T22:12:52.98"
    }
]
Name Description
ServiceID (INT) Internal identifier in RQ
CustomerID (INT) Identifier for a Customer in RQ
ServiceTypeName (NVARCHAR(MAX)) Service Type - name of the type of service
SaleInvoiceID (INT) Identifier for an Invoice in RQ
SaleInvoiceIDByStore (VARCHAR(14)) Invoice # - number of the associated invoice
ProductIdentifier (VARCHAR(12)) Product SKU - RQ generated SKU for this service
Status (VARCHAR(8)) Status - active or disabled
UsersName (VARCHAR(50)) User Name - name of the user of the service
Customer (VARCHAR(151)) Customer - name of the customer as entered on their profile
TrackingNumber (VARCHAR(100)) Tracking # - tracking number associated with this service
ActivationDate (DateTime) Activated On - date the service was activated
ExpiryDate (DateTime) Expires On - date the service expires
ResidualStart (DateTime) Res Start - date residuals begin
ResidualStop (DateTime) Res Stop - date residuals end
AverageBill (MONEY) Average Bill - average bill
RatePlan (VARCHAR(100)) Plan - rate plan
CompletedDate (DateTime) Completed On - date service is completed
Completed (BIT) A flag to indicate if Service is completed
OriginalExpiryDate (DateTime) Originally Expires On - original date the service expires

REQUESTS

GET the Customer List Report

For more information, see Customer List Report.

Definition

GET /reports/customerlistreport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&DatePercision={DatePercision}&TypeOfCustomer={TypeOfCustomer}&FilterBy={FilterBy}&StoreIDLoggedIn={StoreIDLoggedIn}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/customerlistreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/customerlistreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheCustomerListReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/customerlistreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
    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 GettingTheCustomerListReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/customerlistreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2");
     
    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/reports/customerlistreport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&DatePercision=1970-01-01T06:00:00.000Z&TypeOfCustomer=-1&FilterBy=1&StoreIDLoggedIn=1&ForWho=1&ForWhoIDs=6679&LocationType=Store&LocationTypeIDs=1,2', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[CustomerListReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "Address": "12 Hello St.",
        "Address2": "n/a",
        "BillingAccountNumber": "",
        "City": "Fargo",
        "ContactNumber": "5555555555",
        "ContactTypeName": "",
        "Country": "United States",
        "CustomerCompanyName": "KENTEL",
        "CustomerFirstName": "Carrie",
        "CustomerID": 2108754,
        "CustomerLastName": "Madison",
        "DateCreated": "2016-01-26T20:55:53.227",
        "DeclineToProvideEmail": false,
        "Email": "carry@test.iq",
        "EmployeeName": "iQmetrix Employee",
        "EmployeeNameAssignedTo": "iQmetrix Employee",
        "IndustryTypeName": "",
        "MultiLevelPriceID": 1,
        "NumberOfActivations": 0,
        "PositionTypeName": "",
        "PostalCode": "90123",
        "Province": "ND",
        "TracPointMemberNumber": "C2981754hduw",
        "TypeOfCustomer": 3,
        "VIPCustomer": 0
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "Address": "12 Hello St.",
            "Address2": "n/a",
            "BillingAccountNumber": "",
            "City": "Fargo",
            "ContactNumber": "5555555555",
            "ContactTypeName": "",
            "Country": "United States",
            "CustomerCompanyName": "KENTEL",
            "CustomerFirstName": "Carrie",
            "CustomerID": 2108754,
            "CustomerLastName": "Madison",
            "DateCreated": "2016-01-26T20:55:53.227",
            "DeclineToProvideEmail": false,
            "Email": "carry@test.iq",
            "EmployeeName": "iQmetrix Employee",
            "EmployeeNameAssignedTo": "iQmetrix Employee",
            "IndustryTypeName": "",
            "MultiLevelPriceID": 1,
            "NumberOfActivations": 0,
            "PositionTypeName": "",
            "PostalCode": "90123",
            "Province": "ND",
            "TracPointMemberNumber": "C2981754hduw",
            "TypeOfCustomer": 3,
            "VIPCustomer": 0
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <Address>12 Hello St.</Address>
    <Address2>n/a</Address2>
    <BillingAccountNumber></BillingAccountNumber>
    <City>Fargo</City>
    <ContactNumber>5555555555</ContactNumber>
    <ContactTypeName></ContactTypeName>
    <Country>United States</Country>
    <CustomerCompanyName>KENTEL</CustomerCompanyName>
    <CustomerFirstName>Carrie</CustomerFirstName>
    <CustomerID>2108754</CustomerID>
    <CustomerLastName>Madison</CustomerLastName>
    <DateCreated>2016-01-26T20:55:53.227</DateCreated>
    <DeclineToProvideEmail>false</DeclineToProvideEmail>
    <Email>carry@test.iq</Email>
    <EmployeeName>iQmetrix Employee</EmployeeName>
    <EmployeeNameAssignedTo>iQmetrix Employee</EmployeeNameAssignedTo>
    <IndustryTypeName></IndustryTypeName>
    <MultiLevelPriceID>1</MultiLevelPriceID>
    <NumberOfActivations>0</NumberOfActivations>
    <PositionTypeName></PositionTypeName>
    <PostalCode>90123</PostalCode>
    <Province>ND</Province>
    <TracPointMemberNumber>C2981754hduw</TracPointMemberNumber>
    <TypeOfCustomer>3</TypeOfCustomer>
    <VIPCustomer>0</VIPCustomer>
  </Record>
  <Schema>
    <Column_Name>ColumnName</Column_Name>
    <Type>datatybe</Type>
    <SafeType>safetype</SafeType>
    <Length>100</Length>
  </Schema>
</Table>

Example Response (CSV)

HTTP 200 Content-Type: text/csv
Address,Address2,BillingAccountNumber,City,ContactNumber,ContactTypeName,Country,CustomerCompanyName,CustomerFirstName,CustomerID,CustomerLastName,DateCreated,DeclineToProvideEmail,Email,EmployeeName,EmployeeNameAssignedTo,IndustryTypeName,MultiLevelPriceID,NumberOfActivations,PositionTypeName,PostalCode,Province,TracPointMemberNumber,TypeOfCustomer,VIPCustomer
12 Hello St.,n/a,,Fargo,5555555555,,United States,KENTEL,Carrie,2108754,Madison,2016-01-26T20:55:53.227,false,carry@test.iq,iQmetrix Employee,iQmetrix Employee,,1,0,,90123,ND,C2981754hduw,3,0

Example Response (Excel)

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

GET the Customer Contact Status Report

For more information, see Customer Contact Status Report.

Definition

GET /reports/CustomerContactStatusReport?TypeOfSelection={TypeOfSelection}&StoreID={StoreID}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/CustomerContactStatusReport?TypeOfSelection=1&StoreID=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

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

puts response

URI Parameters

Response Parameters

Array[CustomerContactStatusReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "CustomerID": 134945,
        "CustomerName": "John Bates",
        "DateCreated": "2017-04-07T10:37:27.007",
        "ContactNumber": "",
        "Email": "test@example.com",
        "Address": "",
        "Address2": "",
        "City": "Georgetown",
        "Province": "",
        "PostalCode": "",
        "Country": "Argentina",
        "DoNotCall": false,
        "DoNotEmail": true,
        "DoNotPostOfficeMail": false,
        "TypeOfCustomer": "Individual"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "CustomerID": 134945,
            "CustomerName": "John Bates",
            "DateCreated": "2017-04-07T10:37:27.007",
            "ContactNumber": "",
            "Email": "test@example.com",
            "Address": "",
            "Address2": "",
            "City": "Georgetown",
            "Province": "",
            "PostalCode": "",
            "Country": "Argentina",
            "DoNotCall": false,
            "DoNotEmail": true,
            "DoNotPostOfficeMail": false,
            "TypeOfCustomer": "Individual"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <CustomerID>134945</CustomerID>
    <CustomerName>John Bates</CustomerName>
    <DateCreated>2017-04-07T10:37:27.007</DateCreated>
    <ContactNumber></ContactNumber>
    <Email>test@example.com</Email>
    <Address></Address>
    <Address2></Address2>
    <City>Georgetown</City>
    <Province></Province>
    <PostalCode></PostalCode>
    <Country>Argentina</Country>
    <DoNotCall>false</DoNotCall>
    <DoNotEmail>true</DoNotEmail>
    <DoNotPostOfficeMail>false</DoNotPostOfficeMail>
    <TypeOfCustomer>Individual</TypeOfCustomer>
  </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
CustomerID,CustomerName,DateCreated,ContactNumber,Email,Address,Address2,City,Province,PostalCode,Country,DoNotCall,DoNotEmail,DoNotPostOfficeMail,TypeOfCustomer
134945,John Bates,2017-04-07T10:37:27.007,,test@example.com,,,Georgetown,,,Argentina,false,true,false,Individual

Example Response (Excel)

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

GET the Marketing Summary Report

For more information, see Marketing Summary Report.

Definition

GET /reports/MarketingSummaryReport?DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/MarketingSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/MarketingSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheMarketingSummaryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/MarketingSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&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 GettingTheMarketingSummaryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/MarketingSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&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/reports/MarketingSummaryReport?DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[MarketingSummaryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "SaleInvoiceID": 132500,
        "DateCreated": "2017-01-04T10:02:43.313",
        "InvoiceIDByStore": "84WEAIN17153",
        "StoreName": "84 West",
        "CustomerName": "No Customer",
        "MarketingTypeName": "First Type",
        "MarketingTypeStartDate": "2016-05-31T00:00:00",
        "MarketingTypeStopDate": "2016-10-31T00:00:00",
        "Status": "New",
        "Count": 1
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "SaleInvoiceID": 132500,
            "DateCreated": "2017-01-04T10:02:43.313",
            "InvoiceIDByStore": "84WEAIN17153",
            "StoreName": "84 West",
            "CustomerName": "No Customer",
            "MarketingTypeName": "First Type",
            "MarketingTypeStartDate": "2016-05-31T00:00:00",
            "MarketingTypeStopDate": "2016-10-31T00:00:00",
            "Status": "New",
            "Count": 1
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <SaleInvoiceID>132500</SaleInvoiceID>
    <DateCreated>2017-01-04T10:02:43.313</DateCreated>
    <InvoiceIDByStore>84WEAIN17153</InvoiceIDByStore>
    <StoreName>84 West</StoreName>
    <CustomerName>No Customer</CustomerName>
    <MarketingTypeName>First Type</MarketingTypeName>
    <MarketingTypeStartDate>2016-05-31T00:00:00</MarketingTypeStartDate>
    <MarketingTypeStopDate>2016-10-31T00:00:00</MarketingTypeStopDate>
    <Status>New</Status>
    <Count>1</Count>
  </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
SaleInvoiceID,DateCreated,InvoiceIDByStore,StoreName,CustomerName,MarketingTypeName,MarketingTypeStartDate,MarketingTypeStopDate,Status,Count
132500,2017-01-04T10:02:43.313,84WEAIN17153,84 West,No Customer,First Type,2016-05-31T00:00:00,2016-10-31T00:00:00,New,1

Example Response (Excel)

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

GET the Service Request History Report

For more information, see Service Request History Report.

Definition

GET /reports/ServiceRequestHistoryReport?Status={Status}&ServiceType={ServiceType}&DateToSearch={DateToSearch}&DateRange={DateRange}&StartDate={StartDate}&StopDate={StopDate}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/ServiceRequestHistoryReport?Status=-1&ServiceType=-1&DateToSearch=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/ServiceRequestHistoryReport?Status=-1&ServiceType=-1&DateToSearch=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheServiceRequestHistoryReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/ServiceRequestHistoryReport?Status=-1&ServiceType=-1&DateToSearch=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=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 GettingTheServiceRequestHistoryReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/ServiceRequestHistoryReport?Status=-1&ServiceType=-1&DateToSearch=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=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/reports/ServiceRequestHistoryReport?Status=-1&ServiceType=-1&DateToSearch=1&DateRange=Today&StartDate=1970-01-01T06:00:00.000Z&StopDate=2016-01-01T06:00:00.000Z&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ServiceRequestHistoryReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ServiceRequestID": 106,
        "ServiceRequestIDByStore": "TOTLISR5",
        "StoreName": "84 West",
        "CustomerID1": 124051,
        "CustomerName1": "John Bates",
        "CustomerName2": "",
        "EmployeeName1": "iQmetrix Employee",
        "Username1": "iQmetrix.Employee",
        "EmployeeName2": "",
        "EmployeeName3": "",
        "EmployeeName4": "iQmetrix Employee",
        "ContactName": "John Bates",
        "ContactNumber": "(555)555-5555",
        "Priority": 2,
        "FollowUpAfter": 0,
        "Description": "",
        "DateCreated": "2017-01-04T10:07:34.953",
        "DateClosed": "2017-01-04T10:07:34.953",
        "ServiceType": 2,
        "Status": 0,
        "SubStatus": 0,
        "WaybillNumber": "",
        "ShippingMethod": "Regular",
        "ShippingStatus": 0,
        "DateShipped": "2017-01-04T00:00:00",
        "DateReceived": "2017-01-04T10:07:34.953",
        "ShippingETA": "2017-01-04T00:00:00",
        "ShippingComments": "",
        "InternalComments": "",
        "ExternalComments": ""
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ServiceRequestID": 106,
            "ServiceRequestIDByStore": "TOTLISR5",
            "StoreName": "84 West",
            "CustomerID1": 124051,
            "CustomerName1": "John Bates",
            "CustomerName2": "",
            "EmployeeName1": "iQmetrix Employee",
            "Username1": "iQmetrix.Employee",
            "EmployeeName2": "",
            "EmployeeName3": "",
            "EmployeeName4": "iQmetrix Employee",
            "ContactName": "John Bates",
            "ContactNumber": "(555)555-5555",
            "Priority": 2,
            "FollowUpAfter": 0,
            "Description": "",
            "DateCreated": "2017-01-04T10:07:34.953",
            "DateClosed": "2017-01-04T10:07:34.953",
            "ServiceType": 2,
            "Status": 0,
            "SubStatus": 0,
            "WaybillNumber": "",
            "ShippingMethod": "Regular",
            "ShippingStatus": 0,
            "DateShipped": "2017-01-04T00:00:00",
            "DateReceived": "2017-01-04T10:07:34.953",
            "ShippingETA": "2017-01-04T00:00:00",
            "ShippingComments": "",
            "InternalComments": "",
            "ExternalComments": ""
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ServiceRequestID>106</ServiceRequestID>
    <ServiceRequestIDByStore>TOTLISR5</ServiceRequestIDByStore>
    <StoreName>84 West</StoreName>
    <CustomerID1>124051</CustomerID1>
    <CustomerName1>John Bates</CustomerName1>
    <CustomerName2></CustomerName2>
    <EmployeeName1>iQmetrix Employee</EmployeeName1>
    <Username1>iQmetrix.Employee</Username1>
    <EmployeeName2></EmployeeName2>
    <EmployeeName3></EmployeeName3>
    <EmployeeName4>iQmetrix Employee</EmployeeName4>
    <ContactName>John Bates</ContactName>
    <ContactNumber>(555)555-5555</ContactNumber>
    <Priority>2</Priority>
    <FollowUpAfter>0</FollowUpAfter>
    <Description></Description>
    <DateCreated>2017-01-04T10:07:34.953</DateCreated>
    <DateClosed>2017-01-04T10:07:34.953</DateClosed>
    <ServiceType>2</ServiceType>
    <Status>0</Status>
    <SubStatus>0</SubStatus>
    <WaybillNumber></WaybillNumber>
    <ShippingMethod>Regular</ShippingMethod>
    <ShippingStatus>0</ShippingStatus>
    <DateShipped>2017-01-04T00:00:00</DateShipped>
    <DateReceived>2017-01-04T10:07:34.953</DateReceived>
    <ShippingETA>2017-01-04T00:00:00</ShippingETA>
    <ShippingComments></ShippingComments>
    <InternalComments></InternalComments>
    <ExternalComments></ExternalComments>
  </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
ServiceRequestID,ServiceRequestIDByStore,StoreName,CustomerID1,CustomerName1,CustomerName2,EmployeeName1,Username1,EmployeeName2,EmployeeName3,EmployeeName4,ContactName,ContactNumber,Priority,FollowUpAfter,Description,DateCreated,DateClosed,ServiceType,Status,SubStatus,WaybillNumber,ShippingMethod,ShippingStatus,DateShipped,DateReceived,ShippingETA,ShippingComments,InternalComments,ExternalComments
106,TOTLISR5,84 West,124051,John Bates,,iQmetrix Employee,iQmetrix.Employee,,,iQmetrix Employee,John Bates,(555)555-5555,2,0,,2017-01-04T10:07:34.953,2017-01-04T10:07:34.953,2,0,0,,Regular,0,2017-01-04T00:00:00,2017-01-04T10:07:34.953,2017-01-04T00:00:00,,,

Example Response (Excel)

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

GET the Service Manager Report

For more information, see Service Manager Report.

Definition

GET /reports/ServiceManagerReport?Status={Status}&ServiceTypeID={ServiceTypeID}&LocationType={LocationType}&LocationTypeIDs={LocationTypeIDs}&ForWho={ForWho}&ForWhoIDs={ForWhoIDs}&StartActivationDate={StartActivationDate}&StopActivationDate={StopActivationDate}&StartExpiryDate={StartExpiryDate}&StopExpiryDate={StopExpiryDate}&LanguageCode={LanguageCode}&Auth={Auth}&Response={Response}

Headers

Example Request

GET /reports/ServiceManagerReport?Status=0&ServiceTypeID=-1&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&StartActivationDate=1970-01-01T06:00:00.000Z&StopActivationDate=2017-01-01T06:00:00.000Z&StartExpiryDate=1970-01-01T06:00:00.000Z&StopExpiryDate=2017-01-01T06:00:00.000Z&LanguageCode=en-us
Authorization: Bearer (Access Token)
Accept-Encoding: gzip

curl -X GET "https://dataconnectdemo.iqmetrix.net/reports/ServiceManagerReport?Status=0&ServiceTypeID=-1&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&StartActivationDate=1970-01-01T06:00:00.000Z&StopActivationDate=2017-01-01T06:00:00.000Z&StartExpiryDate=1970-01-01T06:00:00.000Z&StopExpiryDate=2017-01-01T06:00:00.000Z&LanguageCode=en-us" -H "Authorization: Bearer (Access Token)" -H "Accept-Encoding: gzip"
static IRestResponse GettingTheServiceManagerReport()
{
    var client = new RestClient("https://dataconnectdemo.iqmetrix.net/reports/ServiceManagerReport?Status=0&ServiceTypeID=-1&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&StartActivationDate=1970-01-01T06:00:00.000Z&StopActivationDate=2017-01-01T06:00:00.000Z&StartExpiryDate=1970-01-01T06:00:00.000Z&StopExpiryDate=2017-01-01T06:00:00.000Z&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 GettingTheServiceManagerReport() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://dataconnectdemo.iqmetrix.net/reports/ServiceManagerReport?Status=0&ServiceTypeID=-1&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&StartActivationDate=1970-01-01T06:00:00.000Z&StopActivationDate=2017-01-01T06:00:00.000Z&StartExpiryDate=1970-01-01T06:00:00.000Z&StopExpiryDate=2017-01-01T06:00:00.000Z&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/reports/ServiceManagerReport?Status=0&ServiceTypeID=-1&LocationType=Store&LocationTypeIDs=1,2&ForWho=4&ForWhoIDs=1&StartActivationDate=1970-01-01T06:00:00.000Z&StopActivationDate=2017-01-01T06:00:00.000Z&StartExpiryDate=1970-01-01T06:00:00.000Z&StopExpiryDate=2017-01-01T06:00:00.000Z&LanguageCode=en-us', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept-Encoding' => 'gzip',
    } 

puts response

URI Parameters

Response Parameters

Array[ServiceManagerReportData]

Example Response (Default)

HTTP 200 Content-Type: application/json
[
    {
        "ServiceID": 17,
        "CustomerID": 125159,
        "ServiceTypeName": "123",
        "SaleInvoiceID": 121863,
        "SaleInvoiceIDByStore": "TALLAIN7263",
        "ProductIdentifier": "ZWRFNS000008",
        "Status": "Disabled",
        "UsersName": "Kobi Labok",
        "Customer": "Emma Stone",
        "TrackingNumber": "56789012345678901234567890",
        "ActivationDate": "2015-02-23T00:00:00",
        "ExpiryDate": "2015-02-26T00:00:00",
        "ResidualStart": "2015-02-26T00:00:00",
        "ResidualStop": "2015-02-26T00:00:00",
        "AverageBill": 0,
        "RatePlan": "1",
        "CompletedDate": "2015-02-23T17:12:50.027",
        "Completed": true,
        "OriginalExpiryDate": "2015-02-28T22:12:52.98"
    }
]

Example Response (JsonDataTable)

HTTP 200 Content-Type: application/json
{
    "Records": [
        {
            "ServiceID": 17,
            "CustomerID": 125159,
            "ServiceTypeName": "123",
            "SaleInvoiceID": 121863,
            "SaleInvoiceIDByStore": "TALLAIN7263",
            "ProductIdentifier": "ZWRFNS000008",
            "Status": "Disabled",
            "UsersName": "Kobi Labok",
            "Customer": "Emma Stone",
            "TrackingNumber": "56789012345678901234567890",
            "ActivationDate": "2015-02-23T00:00:00",
            "ExpiryDate": "2015-02-26T00:00:00",
            "ResidualStart": "2015-02-26T00:00:00",
            "ResidualStop": "2015-02-26T00:00:00",
            "AverageBill": 0,
            "RatePlan": "1",
            "CompletedDate": "2015-02-23T17:12:50.027",
            "Completed": true,
            "OriginalExpiryDate": "2015-02-28T22:12:52.98"
        }
    ],
    "Schema": [
        {
            "Column_Name": "ColumnName",
            "Type": "datatype",
            "SafeType": "safetype",
            "Length": 100
        }
    ]
}

Example Response (XmlDataTable)

HTTP 200 Content-Type: text/xml
<Table>
  <Record>
    <ServiceID>17</ServiceID>
    <CustomerID>125159</CustomerID>
    <ServiceTypeName>123</ServiceTypeName>
    <SaleInvoiceID>121863</SaleInvoiceID>
    <SaleInvoiceIDByStore>TALLAIN7263</SaleInvoiceIDByStore>
    <ProductIdentifier>ZWRFNS000008</ProductIdentifier>
    <Status>Disabled</Status>
    <UsersName>Kobi Labok</UsersName>
    <Customer>Emma Stone</Customer>
    <TrackingNumber>56789012345678901234567890</TrackingNumber>
    <ActivationDate>2015-02-23T00:00:00</ActivationDate>
    <ExpiryDate>2015-02-26T00:00:00</ExpiryDate>
    <ResidualStart>2015-02-26T00:00:00</ResidualStart>
    <ResidualStop>2015-02-26T00:00:00</ResidualStop>
    <AverageBill>0</AverageBill>
    <RatePlan>1</RatePlan>
    <CompletedDate>2015-02-23T17:12:50.027</CompletedDate>
    <Completed>true</Completed>
    <OriginalExpiryDate>2015-02-28T22:12:52.98</OriginalExpiryDate>
  </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
ServiceID,CustomerID,ServiceTypeName,SaleInvoiceID,SaleInvoiceIDByStore,ProductIdentifier,Status,UsersName,Customer,TrackingNumber,ActivationDate,ExpiryDate,ResidualStart,ResidualStop,AverageBill,RatePlan,CompletedDate,Completed,OriginalExpiryDate
17,125159,123,121863,TALLAIN7263,ZWRFNS000008,Disabled,Kobi Labok,Emma Stone,56789012345678901234567890,2015-02-23T00:00:00,2015-02-26T00:00:00,2015-02-26T00:00:00,2015-02-26T00:00:00,0,1,2015-02-23T17:12:50.027,true,2015-02-28T22:12:52.98

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?