API Documentation

In-depth reference documentation for iQmetrix API's.

NAV

OVERVIEW

The Entity Store helps manage your Company structure. It also manages relationships your Company has with Suppliers, Manufacturers and Carriers.

ENDPOINTS

Sandbox: https://entitymanagerdemo.iqmetrix.net/v1
Production: https://entitymanager.iqmetrix.net/v1

RESOURCES

Carrier

{
    "Id": 9,
    "Name": "Helios",
    "DisplayName": "Helios",
    "Description": "",
    "Attributes": {},
    "CreatedUtc": "2014-07-28T20:52:12.929Z",
    "ClientEntityId": "Carrier_25",
    "LastModifiedUtc": "2015-05-20T23:06:29.7700813Z",
    "Logo": {},
    "Relationships": [],
    "Role": "Carrier",
    "Roles": [
        {
            "Name": "Carrier"
        }
    ],
    "SortName": "helios",
    "Version": 1
}
Name Description  
Id (Integer) Unique identifier  
Name (String) Name  
DisplayName (String(250)) Display Name  
Description (String) Description  
Attributes (Object) Set of key-value pairs that contain extra data  
CreatedUtc (DateTime) Created date, in UTC  
ClientEntityId (String) Identifier in an external system  
LastModifiedUtc (DateTime) Last modified date in UTC  
Logo (Object) A reference to an image  
Relationships (Array[object]) Relationships  
Role (String) Role  
Roles (Array[object]) The value must be Carrier  
Roles.Name (String)    
SortName (String) A string used for sorting  
Version (Integer) Latest revision number  
CorrelationId (String) Reserved for internal use  
TypeId (String) Reserved for future use  

Manufacturer

{
    "Id": 13149,
    "Name": "OtterBox",
    "DisplayName": "OtterBox",
    "Description": "#1 Most Trusted Brand in Smartphone Protection",
    "Attributes": {},
    "CreatedUtc": "2015-02-24T19:29:31.073Z",
    "ClientEntityId": "Manufacturer_145",
    "LastModifiedUtc": "2015-05-20T23:06:29.7700813Z",
    "Logo": {},
    "Relationships": [],
    "Role": "Manufacturer",
    "Roles": [
        {
            "Name": "Manufacturer"
        }
    ],
    "SortName": "otterbox",
    "Version": 1
}
Name Description  
Id (Integer) Unique identifier  
Name (String) Name  
DisplayName (String(250)) Display Name  
Description (String) Description  
Attributes (Object) Set of key-value pairs that contain extra data  
CreatedUtc (DateTime) Created date in UTC  
ClientEntityId (String) Identifier in an external system  
LastModifiedUtc (DateTime) Last modified date in UTC  
Logo (Object) A reference to an image  
Relationships (Array[object]) Relationships  
Role (String) Role  
Roles (Array[object]) The value must be Manufacturer  
Roles.Name (String)    
SortName (String) A string used for sorting  
Version (Integer) Latest revision number  
CorrelationId (String) Reserved for internal use  
TypeId (String) Reserved for future use  

Supplier

{
    "Id": 14107,
    "Name": "NOZAMA Inc.",
    "DisplayName": "NOZAMA Inc.",
    "Description": "Provides supplies for KENTEL Corp.",
    "Attributes": {},
    "CreatedUtc": "2015-11-05T18:15:26.558Z",
    "ClientEntityId": "Supplier_151",
    "LastModifiedUtc": "2015-05-20T23:06:29.7700813Z",
    "Logo": {},
    "Relationships": [],
    "Role": "Vendor",
    "Roles": [
        {
            "Name": "Vendor"
        }
    ],
    "SortName": "nozama inc.",
    "Version": 1
}
Name Description  
Id (Integer) Unique identifier  
Name (String) Name  
DisplayName (String(250)) Display Name  
Description (String) Description  
Attributes (Object) Set of key-value pairs that contain extra data  
CreatedUtc (DateTime) Created date in UTC  
ClientEntityId (String) Identifier in an external system  
LastModifiedUtc (DateTime) Last modified date in UTC  
Logo (Object) A reference to an image  
Relationships (Array[object]) Relationships  
Role (String) Role  
Roles (Array[object]) The value must be Vendor  
Roles.Name (String)    
SortName (String) A string used for sorting  
Version (Integer) Latest revision number  
CorrelationId (String) Reserved for internal use  
TypeId (String) Reserved for future use  

REQUESTS

GET All Carriers

Request

GET /Carriers

Example Request

GET /Carriers
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://entitymanagerdemo.iqmetrix.net/v1/Carriers" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingAllCarriers()
{
    var client = new RestClient("https://entitymanagerdemo.iqmetrix.net/v1/Carriers");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    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 GettingAllCarriers() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://entitymanagerdemo.iqmetrix.net/v1/Carriers");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://entitymanagerdemo.iqmetrix.net/v1/Carriers', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": 9,
        "Name": "Helios",
        "DisplayName": "Helios",
        "Description": "",
        "Attributes": {},
        "CreatedUtc": "2014-07-28T20:52:12.929Z",
        "ClientEntityId": "Carrier_25",
        "LastModifiedUtc": "2015-05-20T23:06:29.7700813Z",
        "Logo": {},
        "Relationships": [],
        "Role": "Carrier",
        "Roles": [
            {
                "Name": "Carrier"
            }
        ],
        "SortName": "helios",
        "Version": 1
    }
]

Array[Carrier]

GET a Carrier

Request

GET /Carriers({CarrierId})

Example Request

GET /Carriers(9)
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://entitymanagerdemo.iqmetrix.net/v1/Carriers(9)" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingACarrier()
{
    var client = new RestClient("https://entitymanagerdemo.iqmetrix.net/v1/Carriers(9)");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    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 GettingACarrier() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://entitymanagerdemo.iqmetrix.net/v1/Carriers(9)");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://entitymanagerdemo.iqmetrix.net/v1/Carriers(9)', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": 9,
    "Name": "Helios",
    "DisplayName": "Helios",
    "Description": "",
    "Attributes": {},
    "CreatedUtc": "2014-07-28T20:52:12.929Z",
    "ClientEntityId": "Carrier_25",
    "LastModifiedUtc": "2015-05-20T23:06:29.7700813Z",
    "Logo": {},
    "Relationships": [],
    "Role": "Carrier",
    "Roles": [
        {
            "Name": "Carrier"
        }
    ],
    "SortName": "helios",
    "Version": 1
}

Carrier

GET All Manufacturers

Request

GET /Manufacturers

Example Request

GET /Manufacturers
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://entitymanagerdemo.iqmetrix.net/v1/Manufacturers" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingAllManufacturers()
{
    var client = new RestClient("https://entitymanagerdemo.iqmetrix.net/v1/Manufacturers");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    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 GettingAllManufacturers() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://entitymanagerdemo.iqmetrix.net/v1/Manufacturers");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://entitymanagerdemo.iqmetrix.net/v1/Manufacturers', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": 13149,
        "Name": "OtterBox",
        "DisplayName": "OtterBox",
        "Description": "#1 Most Trusted Brand in Smartphone Protection",
        "Attributes": {},
        "CreatedUtc": "2015-02-24T19:29:31.073Z",
        "ClientEntityId": "Manufacturer_145",
        "LastModifiedUtc": "2015-05-20T23:06:29.7700813Z",
        "Logo": {},
        "Relationships": [],
        "Role": "Manufacturer",
        "Roles": [
            {
                "Name": "Manufacturer"
            }
        ],
        "SortName": "otterbox",
        "Version": 1
    }
]

Array[Manufacturer]

GET a Manufacturer

Request

GET /Manufacturers({ManufacturerId})

Example Request

GET /Manufacturers(13149)
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://entitymanagerdemo.iqmetrix.net/v1/Manufacturers(13149)" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingAManufacturer()
{
    var client = new RestClient("https://entitymanagerdemo.iqmetrix.net/v1/Manufacturers(13149)");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    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 GettingAManufacturer() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://entitymanagerdemo.iqmetrix.net/v1/Manufacturers(13149)");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://entitymanagerdemo.iqmetrix.net/v1/Manufacturers(13149)', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": 13149,
    "Name": "OtterBox",
    "DisplayName": "OtterBox",
    "Description": "#1 Most Trusted Brand in Smartphone Protection",
    "Attributes": {},
    "CreatedUtc": "2015-02-24T19:29:31.073Z",
    "ClientEntityId": "Manufacturer_145",
    "LastModifiedUtc": "2015-05-20T23:06:29.7700813Z",
    "Logo": {},
    "Relationships": [],
    "Role": "Manufacturer",
    "Roles": [
        {
            "Name": "Manufacturer"
        }
    ],
    "SortName": "otterbox",
    "Version": 1
}

Manufacturer

GET all Suppliers

Request

GET /Suppliers

Example Request

GET /Suppliers
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://entitymanagerdemo.iqmetrix.net/v1/Suppliers" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingAllSuppliers()
{
    var client = new RestClient("https://entitymanagerdemo.iqmetrix.net/v1/Suppliers");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    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 GettingAllSuppliers() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://entitymanagerdemo.iqmetrix.net/v1/Suppliers");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://entitymanagerdemo.iqmetrix.net/v1/Suppliers', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
[
    {
        "Id": 14107,
        "Name": "NOZAMA Inc.",
        "DisplayName": "NOZAMA Inc.",
        "Description": "Provides supplies for KENTEL Corp.",
        "Attributes": {},
        "CreatedUtc": "2015-11-05T18:15:26.558Z",
        "ClientEntityId": "Supplier_151",
        "LastModifiedUtc": "2015-05-20T23:06:29.7700813Z",
        "Logo": {},
        "Relationships": [],
        "Role": "Vendor",
        "Roles": [
            {
                "Name": "Vendor"
            }
        ],
        "SortName": "nozama inc.",
        "Version": 1
    }
]

Array[Supplier]

GET a Supplier

Request

GET /Suppliers({SupplierId})

Example Request

GET /Suppliers(14107)
Authorization: Bearer (Access Token)
Accept: application/json

curl -X GET "https://entitymanagerdemo.iqmetrix.net/v1/Suppliers(14107)" -H "Authorization: Bearer (Access Token)" -H "Accept: application/json"
static IRestResponse GettingASupplier()
{
    var client = new RestClient("https://entitymanagerdemo.iqmetrix.net/v1/Suppliers(14107)");
    var request = new RestRequest(Method.GET);
     
    request.AddHeader("Authorization", "Bearer (Access Token)"); 
    request.AddHeader("Accept", "application/json"); 

    

    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 GettingASupplier() throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet("https://entitymanagerdemo.iqmetrix.net/v1/Suppliers(14107)");
     
    request.addHeader("Authorization", "Bearer (Access Token)"); 
    request.addHeader("Accept", "application/json"); 
    
    return httpClient.execute(request);
}
require 'rest-client'



response = RestClient.get 'https://entitymanagerdemo.iqmetrix.net/v1/Suppliers(14107)', {
     :'Authorization' => 'Bearer (Access Token)',
     :'Accept' => 'application/json',
    } 

puts response

URI Parameters

Response Parameters

Example Response

HTTP 200 Content-Type: application/json
{
    "Id": 14107,
    "Name": "NOZAMA Inc.",
    "DisplayName": "NOZAMA Inc.",
    "Description": "Provides supplies for KENTEL Corp.",
    "Attributes": {},
    "CreatedUtc": "2015-11-05T18:15:26.558Z",
    "ClientEntityId": "Supplier_151",
    "LastModifiedUtc": "2015-05-20T23:06:29.7700813Z",
    "Logo": {},
    "Relationships": [],
    "Role": "Vendor",
    "Roles": [
        {
            "Name": "Vendor"
        }
    ],
    "SortName": "nozama inc.",
    "Version": 1
}

Supplier

Was this page helpful?