DataConnect - Partner - Common (1.0)

The endpoints listed here are provided to be used by the iQmetrix Partners.

DataConnect is a web based connector service you can use to extract data from iQmetrix using a by making simple web data requests. It provides endpoints for common data requirements, various auth mechanisms and other utility endpoints.

Found a Mistake?

We appreciate your patience as we work to improve the documentation for DataConnect. If you have noticed a mistake or have a qustion, please let us know at apisupport [at] iqmetrix [dot] com, subject "Documentation Issue".

Common Parameters

For a complete list of parameters that are accessible to all DataConnect endpoints, see Relationships.

Security Protocols

We recommend that users use TLS 1.2 when connecting to DataConnect.

Error Messages

DataConnect returns standard HTTP status codes (400, 401, 403, 404, 500, 503) and readable error messages. For an example of these messages see Relationships.

Authentication

bearerAuth

Bearer token. See Obtaining an Access Token.

Once authenticated DataConnect will pass back a session cookie, this cookie should be provided on each subsequent data request to make use of your existing session for performance purposes.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Relationships

Get Relationships

This endpoint is used to retrieve a list of RQ databases a partner has access to.

The optional Parameters described in this endpoint are common to every endpoint within DataConnect.

In addition to the features outlined here, DataConnect also supports parameters in the body of a request (POST request). If the same parameter appears in the Body and the URL, preference is given to the URL parameter.

The "PreferredEndpoint" property provides the URL you should use for each client for optimal results. While this usage is optional it is recommended for the lowest latency for processing requests.

Authorizations:
query Parameters
Encoding
string
Example: Encoding=utf-8

Providing URL parameter Encoding=uft-8 will encode the response in the utf-8 format.

Help
string
Default: "False"
Enum: "True" "False"
Example: Help=True

A common parameter of Help when True will return the technical definition of the input parameters for the requested endpoint. The response also includes details on how the provided parameters are mapped/converted for execution.

RQ
string
Default: "False"
Enum: "True" "False"
Example: RQ=True

While DataConnect by default returns data with columns named in a way commonly used for SQL storage of such data the parameter of RQ when True will rename the columns of data to match what is found in RQ.

Response
string
Default: "Json"
Enum: "Json" "JsonDataTable" "Xml" "XmlDataTable" "Csv" "Excel" "Excel.Email" "Csv.Email" "Xml.Email" "Excel.FTP" "Csv.FTP" "Xml.FTP" "Excel.SFTP" "Csv.SFTP" "Xml.SFTP" "Excel.FTPS" "Csv.FTPS" "Xml.FTPS"
Example: Response=JsonDataTable

DataConnect supports different response options, including Json, XML, JsonDataTable (includes schema and business descriptions of data), Xml and XmlDataTable.

CSV.Delimiter
string
Default: ","
Example: CSV.Delimiter=|

Used if Response=[Csv,Csv.FTP,Csv.Email,Csv.FTP,Csv.SFTP, Csv.FTPS]. If the response contains a string that also contains the delimiter the entire string is escaped in quotes.

CSV.FileExtension
string
Default: "csv"
Example: CSV.FileExtension=csv

Used if Response=[Csv,Csv.FTP,Csv.Email,Csv.FTP,Csv.SFTP, Csv.FTPS]. File extension

CSV.Headers
string
Default: "True"
Example: CSV.Headers=True

Used if Response=[Csv,Csv.FTP,Csv.Email,Csv.FTP,Csv.SFTP, Csv.FTPS]. A flag to indicate if CSV headers should be included

Email.To
string
Example: Email.To=recipient2@domain.com

Required if Response=[Csv,Excel,Xml].Email. Semicolon delimited list of emails to include as To

Email.Cc
string
Example: Email.Cc=recipient2@domain.com

Used if Response=[Csv,Excel,Xml].Email. Semicolon delimited list of emails to include as CC

Email.Subject
string
Example: Email.Subject=Test Data

Used if Response=[Csv,Excel,Xml].Email. The subject of the email. Defaults to the resource being requested with the current date.

Email.Compress
string
Default: false
Example: Email.Compress=false

Used if Response=[Csv,Excel,Xml].Email. A flag to indicate if the requested document should be compressed into a zip file (true) or not (false)

Filename
string
Example: Filename=MyReport

Used if Response=[Csv,Excel,Xml].[Email,FTP,SFTP,FTPS]. Defaults to the resource being requested with today's date

FTP.Host
string
Example: FTP.Host=ftp.domain.com

Required if Response=[Excel,Csv,Xml].FTP

FTP.Port
number
Default: 21
Example: FTP.Port=21

Used when Response=[Excel,Csv,Xml].FTP

FTP.Username
string
Example: FTP.Username=Username

Required if Response=[Excel,Csv,Xml].FTP.

FTP.Password
string
Example: FTP.Password=Password

Required if Response=[Excel,Csv,Xml].FTP.

FTP.Path
string
Default: "/"
Example: FTP.Path=/upload/

Used when Response=[Excel,Csv,Xml].FTP.

SFTP.Host
string
Example: SFTP.Host=sftp.domain.com

Required if Response=[Excel,Csv,Xml].SFTP.

SFTP.Port
number
Default: 22
Example: SFTP.Port=22

Used when Response=[Excel,Csv,Xml].SFTP

SFTP.Username
string
Example: SFTP.Username=Username

Required if Response=[Excel,Csv,Xml].SFTP.

SFTP.Password
string
Example: SFTP.Password=Password

Required if Response=[Excel,Csv,Xml].SFTP.

SFTP.Path
string
Default: "/"
Example: SFTP.Path=/upload/

Used when Response=[Excel,Csv,Xml].SFTP.

FTPS.Host
string
Example: FTPS.Host=ftps.domain.com

Required if Response=[Excel,Csv,Xml].FTPS

FTPS.Port
number
Example: FTPS.Port=990

Used when Response=[Excel,Csv,Xml].FTPS

FTPS.Username
string
Example: FTPS.Username=Username

Required if Response=[Excel,Csv,Xml].FTPS

FTPS.Password
string
Example: FTPS.Password=Password

Required if Response=[Excel,Csv,Xml].FTPS

FTPS.Path
string
Default: "/"
Example: FTPS.Path=/upload/

Used when Response=[Excel,Csv,Xml].FTPS

header Parameters
Accept-Encoding
string
Enum: "gzip" "deflate"
Example: gzip

Compression algorithms are supported for gzip and deflate in the Accept-Encoding header.

Responses

200

Successful Response

400

An error indicating a required parameter was not supplied.

413

Row Limiting Applied.

For some endpoints this guard attempts to estimate the number of records that will be returned on a request. If greater than 1,048,576 (Matches row limit for Microsoft Excel) records would be returned the request is blocked.

429

Rate/Resource Limiting Applied.

get /Partner/relationships

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Partner/relationships

Production

https://dataconnect.iqmetrix.net/Partner/relationships

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

General

Ping

This unsecured endpoint returns the API version.

Responses

200

Successful Response

get /Ping

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Ping

Production

https://dataconnect.iqmetrix.net/Ping

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "ApplicationName": "IQ.DataConnect.Web.WebApplication",
  • "ApplicationVersion": "1.3.0.51"
}

Customers

A great way to get customer data including deltas.

Authorizations:
query Parameters
CompanyID
required
integer
Example: CompanyID=21090

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For a list of acceptable values, see Languages.

LocationType
string
Example: LocationType=Company

When provided, will filter based on the Location Tree. For a list of acceptable values, see LocationType.

LocationTypeIDs
string
Default: "-1"
Example: LocationTypeIDs=100,101

Will filter based on the ID(s) within the Company Tree level indicated in LocationType. For multiple locations, use comma to separate IDs. For a list of acceptable values, see LocationTypeIDs.

StartDate
string <date>
Example: StartDate=2019-06-01

Initial date and time of the search period, filters based on LastUpdatedDate

StopDate
string <date>
Example: StopDate=2019-12-31

End date and time of the search period, filters based on LastUpdatedDate

CustomerEntityID
string <guid>
Example: CustomerEntityID=834abbd7-ed4c-4fc0-986b-f3b9aa4ef0b6

Unique identifier of the customer in the CRM API. This value is used to filter the response to one single customer.

CustomerID
integer
Example: CustomerID=6646

Internal identifier of the customer in RQ

PrimaryName
string
Example: PrimaryName=Jim

First name of the customer

FamilyName
string
Example: FamilyName=Bean

Last name of the customer

CompanyName
string
Example: CompanyName=Kentel

Company name

CustomerTypeID
integer
Enum: 1 2 3
Example: CustomerTypeID=1

Type of the customer. Acceptable values include 1 (None), 2 (Person), 3 (Company)

Phone
string
Example: Phone=5555555555

Phone of the customer

Email
string
Example: Email=test@test.com

Email of the customer

EmployeeID
number
Example: EmployeeID=64326

Internal identifier of the employee in RQ. For a list of acceptable values, see Employees.

RowThumbprint
string <guid>
Example: RowThumbprint=38dc37d2-853a-4343-8518-93a44989243a

Unique identifier of a thumbprint

MemberNumber
string
Example: MemberNumber=R415T671101

Member number of the customer

RowEvent
string
Enum: "Inserted" "Updated"
Example: RowEvent=Inserted

Supports either Inserted or Updated

Responses

200

Successful Response

get /Partner/general/Customers

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Partner/general/Customers

Production

https://dataconnect.iqmetrix.net/Partner/general/Customers

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Lists

VendorAccountID

Returns a list of all Vendor Accounts.

Authorizations:
query Parameters
CompanyID
required
integer
Example: CompanyID=21090

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

Responses

200

Successful Response

get /Partner/Lists/VendorAccountID

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Partner/Lists/VendorAccountID

Production

https://dataconnect.iqmetrix.net/Partner/Lists/VendorAccountID

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

AttachmentRates

Returns a list of Attachment Rates configured within RQ.

Authorizations:
query Parameters
CompanyID
required
integer
Example: CompanyID=21090

Identifier for a Company. For a list of acceptable values, see Relationships endpoint.

LanguageCode
string
Default: "en-us"
Example: LanguageCode=en-us

For a list of acceptable values, see Languages.

AttachmentRateIntId
string <guid>
Example: AttachmentRateIntId=c4dbb979-bc96-4e4f-9052-962c77120fe5

ID of the Attachment Rate

Enabled
string
Enum: 0 1
Example: Enabled=0

Acceptable values are 0: Disabled / 1: Enabled

Hidden
string
Enum: 0 1
Example: Hidden=0

Acceptable values 0: Visible / 1: Hidden

Responses

200

Successful Response

get /Partner/Lists/AttachmentRates

Release Candidate (RC)

https://dataconnectrc.iqmetrix.net/Partner/Lists/AttachmentRates

Production

https://dataconnect.iqmetrix.net/Partner/Lists/AttachmentRates

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

BillPayProviderID

Returns a list of Bill Pay providers configured in RQ.

Authorizations:
query Parameters
CompanyID
required
integer
Example: CompanyID=21090

Iden