NAV
cURL JavaScript PHP

Navarik catalog Management REST API Documentation v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Version 1.0

Base URLs:

Email: Navarik REST API Support

Authentication

session

Sessions management.

Login with Web Service Account credentials to retrieve the session api_key.

Code samples

# You can also use wget
curl -X POST /api/rest/1.0/sessions/{username} \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json'

const inputBody = '{
  "password": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/api/rest/1.0/sessions/{username}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/rest/1.0/sessions/{username}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /sessions/{username}

Login

Body parameter

password: string

Parameters

Name In Type Required Description
username path string true Username for Web Service User Account
body body object true none
» password body string true Password for Web Service User Account

Example responses

200 Response

{
  "sessionName": "string",
  "sessionId": "string",
  "username": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful response Session

grade

Grades catalog.

Search grades

Code samples

# You can also use wget
curl -X GET /api/rest/1.0/grades \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/grades',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/rest/1.0/grades', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /grades

Parameters

Name In Type Required Description
page query integer false Page
Default: 1
resultsPerPage query integer false Results per page
Default: 25
Maximum: 200
dateModifiedFrom query string(date-time) false Date modified from
Example: 2016-01-16 00:00:00
dateModifiedTo query string(date-time) false Date modified to
Example: 2016-02-16 23:59:59
clientCodes query string false Client codes in JSON format
Example: ["code1","code2"]
Maximum: 200

Example responses

200 Response

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "clientCode": "string",
      "name": "string",
      "gradeTypeCode": "string",
      "description": "string",
      "gradeStatusCode": "ACTIVE",
      "isSensitive": true,
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful response Grades

Get grade detail

Code samples

# You can also use wget
curl -X GET /api/rest/1.0/grades/{clientCode} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/grades/{clientCode}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/rest/1.0/grades/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /grades/{clientCode}

Parameters

Name In Type Required Description
clientCode path string true Resource client code

Example responses

200 Response

{
  "clientCode": "string",
  "name": "string",
  "gradeTypeCode": "string",
  "description": "string",
  "gradeStatusCode": "ACTIVE",
  "isSensitive": true,
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful response GradeExtra

Create or update a grade

Code samples

# You can also use wget
curl -X PUT /api/rest/1.0/grades/{clientCode} \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json'

const inputBody = '{
  "name": "string",
  "gradeTypeCode": "LIGHT",
  "description": "string",
  "gradeStatusCode": "ACTIVE",
  "isSensitive": true
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('/api/rest/1.0/grades/{clientCode}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/x-www-form-urlencoded',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/rest/1.0/grades/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /grades/{clientCode}

Body parameter

name: string
gradeTypeCode: LIGHT
description: string
gradeStatusCode: ACTIVE
isSensitive: true

Parameters

Name In Type Required Description
clientCode path string true Resource client code
body body object true none
» name body string true Grade name
» gradeTypeCode body string true Grade type
» description body string true Grade description
» gradeStatusCode body string true Grade status
» isSensitive body boolean true Grade is sensitive

Enumerated Values

Parameter Value Parent Grade Category / Description
» gradeTypeCode NDP_BIODIESEL Biofuel / Biodiesel
» gradeTypeCode NDP_ETHANOL Biofuel / Ethanol
» gradeTypeCode NDP_HYDROGEN Chemical / Hydrogen
» gradeTypeCode NDP_SULFUR Chemical / Sulfur
» gradeTypeCode NDP_CONDENSATE Crudes / Condensate
» gradeTypeCode NDP_CRUDE Crudes / Crude
» gradeTypeCode NDP_SYNTHETIC_CRUDE Crudes / Synthetic Crude
» gradeTypeCode NDP_CYCLE_OIL Cutter / Cycle Oil
» gradeTypeCode NDP_ATMOSPHERIC_RESIDUE Feedstock / Atmospheric Residue
» gradeTypeCode NDP_CARBON_BLACK_OIL Feedstock / Carbon Black Oil
» gradeTypeCode NDP_COKER_GASOIL Feedstock / Coker Gasoil
» gradeTypeCode NDP_DECANT_OIL Feedstock / Decant Oil
» gradeTypeCode NDP_HYDROCRAKATE_RECYCLE_OIL Feedstock / Hydrocrakate Recycle Oil
» gradeTypeCode NDP_STRAIGHT_RUN_FUEL_OIL Feedstock / Straight Run Fuel Oil
» gradeTypeCode NDP_TRANSMIX Feedstock / Transmix
» gradeTypeCode NDP_VACUUM_GASOIL Feedstock / Vacuum Gasoil
» gradeTypeCode NDP_VACUUM_RESIDUE Feedstock / Vacuum Residue
» gradeTypeCode NDP_AVIATION_GASOLINE Gasoline / Aviation Gasoline
» gradeTypeCode NDP_MOTOR_GASOLINE Gasoline / Motor Gasoline
» gradeTypeCode NDP_ALKYLATE Gasoline Components / Alkylate
» gradeTypeCode NDP_COKER_GASOLINE_COKER_NAPHTHA Gasoline Components / Coker Gasoline (Coker Naphtha)
» gradeTypeCode NDP_DIMERATE_ISOOCTANE Gasoline Components / Dimerate (IsoOctane)
» gradeTypeCode NDP_FLUID_CATALYTIC_CRACKER _GASOLINE_FCC_NAPHTHA Gasoline Components / Fluid Catalytic Cracker Gasoline (FCC Naphtha)
» gradeTypeCode NDP_HYDROCRAKATE Gasoline Components / Hydrocrakate
» gradeTypeCode NDP_ISOMERATE Gasoline Components / Isomerate
» gradeTypeCode NDP_POLYMERATE Gasoline Components / Polymerate
» gradeTypeCode NDP_PYROLYSIS_GASOLINE Gasoline Components / Pyrolysis Gasoline
» gradeTypeCode NDP_RAFFINATE Gasoline Components / Raffinate
» gradeTypeCode NDP_REFORMATE Gasoline Components / Reformate
» gradeTypeCode NDP_VISBREAKER_GASOLINE _VISBREAKER_NAPHTHA Gasoline Components / Visbreaker Gasoline (Visbreaker Naphtha)
» gradeTypeCode NDP_RESIDUAL_FUEL_OIL Heavy Fuel Oils / Residual Fuel Oil
» gradeTypeCode NDP_JET Kerosenes / Jet
» gradeTypeCode NDP_KEROSENE Kerosenes / Kerosene
» gradeTypeCode NDP_KEROSENE_BLENDSTOCK Kerosenes / Kerosene Blendstock
» gradeTypeCode NDP_TETRA_ETHYL_LEAD_TEL Lead / Tetra Ethyl Lead (TEL)
» gradeTypeCode NDP_DIESEL_FUELS Light Fuel Oils & Gas Oils / Diesel Fuels
» gradeTypeCode NDP_DISTILLATE_BLENDSTOCK Light Fuel Oils & Gas Oils / Distillate Blendstock
» gradeTypeCode NDP_LIGHT_FUEL_OIL Light Fuel Oils & Gas Oils / Light Fuel Oil
» gradeTypeCode NDP_HEAVY_NAPHTHA_NAPHTHENES _AND_AROMATICS_NAPHTHA Naphthas / Heavy Naphtha (Naphthenes and Aromatics naphtha)
» gradeTypeCode NDP_LIGHT_NAPHTHA Naphthas / Light Naphtha
» gradeTypeCode NDP_LIQUEFIED_NATURAL_GAS Natural Gas / Liquefied Natural Gas
» gradeTypeCode NDP_METHANE Natural Gas / Methane
» gradeTypeCode NDP_ETHYL_TERTIARY_BUTYL_ETHER_ETBE Oxygenates / Ethyl Tertiary Butyl Ether (ETBE)
» gradeTypeCode NDP_METHANOL Oxygenates / Methanol
» gradeTypeCode NDP_METHYL_TERTIARY_BUTYL_ETHER_MTBE Oxygenates / Methyl Tertiary Butyl Ether (MTBE)
» gradeTypeCode NDP_TERTIARY_AMYL_METHYL_ETHER_TAME Oxygenates / Tertiary Amyl Methyl Ether (TAME)
» gradeTypeCode NDP_AROMATICS Petrochemicals / Aromatics
» gradeTypeCode NDP_BENZENE Petrochemicals / Benzene
» gradeTypeCode NDP_BUTADIENE Petrochemicals / Butadiene
» gradeTypeCode NDP_BUTYLENE Petrochemicals / Butylene
» gradeTypeCode NDP_ETHYLENE Petrochemicals / Ethylene
» gradeTypeCode NDP_ISOBUTYLENE Petrochemicals / Isobutylene
» gradeTypeCode NDP_PROPYLENE Petrochemicals / Propylene
» gradeTypeCode NDP_TOULENE Petrochemicals / Toulene
» gradeTypeCode NDP_XYLENE Petrochemicals / Xylene
» gradeTypeCode NDP_BUTANE Petroleum Gas Liquids (PGLs) / Butane
» gradeTypeCode NDP_ETHANE Petroleum Gas Liquids (PGLs) / Ethane
» gradeTypeCode NDP_PROPANE Petroleum Gas Liquids (PGLs) / Propane
» gradeTypeCode NDP_ASPHALT/BITUMEN Specialty Products / Asphalt/Bitumen
» gradeTypeCode NDP_BASE_OILS_&_FINISHED_LUBRICANTS Specialty Products / Base Oils & Finished Lubricants
» gradeTypeCode NDP_CARBON_BLACK Specialty Products / Carbon Black
» gradeTypeCode NDP_PETROLEUM_COKE Specialty Products / Petroleum Coke
» gradeTypeCode NDP_WAXES Specialty Products / Waxes
» gradeStatusCode ACTIVE
» gradeStatusCode INACTIVE

Example responses

200 Response

{
  "clientCode": "string",
  "name": "string",
  "gradeTypeCode": "string",
  "description": "string",
  "gradeStatusCode": "ACTIVE",
  "isSensitive": true
}

Responses

Status Meaning Description Schema
200 OK Resource Updated Grade
201 Created Resource Created Grade

Delete or deactivate a grade

Code samples

# You can also use wget
curl -X DELETE /api/rest/1.0/grades/{clientCode} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/grades/{clientCode}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/rest/1.0/grades/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /grades/{clientCode}

Parameters

Name In Type Required Description
clientCode path string true Resource client code

Example responses

200 Response

{
  "clientCode": "string",
  "statusCode": "ACTIVE"
}

Responses

Status Meaning Description Schema
200 OK Successful response ResourceStatus

company

Companies catalog.

Search companies

Code samples

# You can also use wget
curl -X GET /api/rest/1.0/companies \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/companies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/rest/1.0/companies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /companies

Parameters

Name In Type Required Description
page query integer false Page
Default: 1
resultsPerPage query integer false Results per page
Default: 25
Maximum: 100
dateModifiedFrom query string(date-time) false Date modified from
Example: 2016-01-16 00:00:00
dateModifiedTo query string(date-time) false Date modified to
Example: 2016-02-16 23:59:59
clientCodes query string false Client codes in JSON format
Example: ["code1","code2"]
Maximum: 100

Example responses

200 Response

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "clientCode": "string",
      "name": "string",
      "statusCode": "ACTIVE",
      "companyRoles": [
        "string"
      ],
      "headOfficeName": "string",
      "headOfficeDescription": "string",
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful response Companies

Get contact company detail

Code samples

# You can also use wget
curl -X GET /api/rest/1.0/companies/contact/{clientCode} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/companies/contact/{clientCode}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/rest/1.0/companies/contact/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /companies/contact/{clientCode}

Parameters

Name In Type Required Description
clientCode path string true Resource client code

Example responses

200 Response

{
  "clientCode": "string",
  "name": "string",
  "statusCode": "ACTIVE",
  "companyRoles": [
    "string"
  ],
  "headOfficeName": "string",
  "headOfficeDescription": "string",
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful response CompanyBase

Create or update a contact company and its head office

Code samples

# You can also use wget
curl -X PUT /api/rest/1.0/companies/{clientCode} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const inputBody = '{
  "name": "string",
  "headOffice": {
    "name": "string",
    "description": "string",
    "contact": {
      "addresses": [
        {
          "isPreferred": true,
          "address": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "countryCode": "US",
          "addressTypeCode": "WORK"
        }
      ],
      "emails": [
        {
          "isPreferred": true,
          "address": "string",
          "emailTypeCode": "WORK"
        }
      ],
      "urls": [
        {
          "isPreferred": true,
          "address": "string",
          "urlTypeCode": "WORK"
        }
      ],
      "phones": [
        {
          "isPreferred": true,
          "phoneNumber": "string",
          "phoneTypeCode": "WORK"
        }
      ]
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/rest/1.0/companies/{clientCode}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/rest/1.0/companies/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /companies/{clientCode}

Body parameter

{
  "name": "string",
  "headOffice": {
    "name": "string",
    "description": "string",
    "contact": {
      "addresses": [
        {
          "isPreferred": true,
          "address": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "countryCode": "US",
          "addressTypeCode": "WORK"
        }
      ],
      "emails": [
        {
          "isPreferred": true,
          "address": "string",
          "emailTypeCode": "WORK"
        }
      ],
      "urls": [
        {
          "isPreferred": true,
          "address": "string",
          "urlTypeCode": "WORK"
        }
      ],
      "phones": [
        {
          "isPreferred": true,
          "phoneNumber": "string",
          "phoneTypeCode": "WORK"
        }
      ]
    }
  }
}

Parameters

Name In Type Required Description
clientCode path string true Resource client code
body body Company true none

Example responses

200 Response

{
  "name": "string",
  "headOffice": {
    "name": "string",
    "description": "string",
    "contact": {
      "addresses": [
        {
          "isPreferred": true,
          "address": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "countryCode": "US",
          "addressTypeCode": "WORK"
        }
      ],
      "emails": [
        {
          "isPreferred": true,
          "address": "string",
          "emailTypeCode": "WORK"
        }
      ],
      "urls": [
        {
          "isPreferred": true,
          "address": "string",
          "urlTypeCode": "WORK"
        }
      ],
      "phones": [
        {
          "isPreferred": true,
          "phoneNumber": "string",
          "phoneTypeCode": "WORK"
        }
      ]
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Resource Updated Company
201 Created Resource Created Company

Delete or deactivate a contact company

Code samples

# You can also use wget
curl -X DELETE /api/rest/1.0/companies/{clientCode} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/companies/{clientCode}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/rest/1.0/companies/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /companies/{clientCode}

Parameters

Name In Type Required Description
clientCode path string true Resource client code

Example responses

200 Response

{
  "clientCode": "string",
  "statusCode": "ACTIVE"
}

Responses

Status Meaning Description Schema
200 OK Successful response ResourceStatus

port

Locations catalog.

Search ports

Code samples

# You can also use wget
curl -X GET /api/rest/1.0/ports \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/ports',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/rest/1.0/ports', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /ports

Parameters

Name In Type Required Description
page query integer false Page
Default: 1
resultsPerPage query integer false Results per page
Default: 25
Maximum: 200
dateModifiedFrom query string(date-time) false Date modified from
Example: 2016-01-16 00:00:00
dateModifiedTo query string(date-time) false Date modified to
Example: 2016-02-16 23:59:59
clientCodes query string false Client codes in JSON format
Example: ["code1","code2"]
Maximum: 200

Example responses

200 Response

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "name": "string",
      "countryCode": "US",
      "geoRegionCode": "string",
      "latitudeDeg": 0,
      "latitudeMin": 0,
      "latitudeSec": 0,
      "latitudeNs": "N",
      "longitudeDeg": 0,
      "longitudeMin": 0,
      "longitudeSec": 0,
      "longitudeWe": "W",
      "statusCode": "ACTIVE",
      "restrictions": "string",
      "generalComments": "string",
      "clientCode": "string",
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful response Locations

Get port detail

Code samples

# You can also use wget
curl -X GET /api/rest/1.0/ports/{clientCode} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/ports/{clientCode}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/rest/1.0/ports/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /ports/{clientCode}

Parameters

Name In Type Required Description
clientCode path string true Resource client code

Example responses

200 Response

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string",
  "clientCode": "string",
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful response LocationBase

Create or update a port

Code samples

# You can also use wget
curl -X PUT /api/rest/1.0/ports/{clientCode} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const inputBody = '{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/rest/1.0/ports/{clientCode}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/rest/1.0/ports/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /ports/{clientCode}

Body parameter

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string"
}

Parameters

Name In Type Required Description
clientCode path string true Resource client code
body body Location true none

Example responses

200 Response

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string"
}

Responses

Status Meaning Description Schema
200 OK Resource Updated Location
201 Created Resource Created Location

Delete or deactivate a port

Code samples

# You can also use wget
curl -X DELETE /api/rest/1.0/ports/{clientCode} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/ports/{clientCode}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/rest/1.0/ports/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /ports/{clientCode}

Parameters

Name In Type Required Description
clientCode path string true Resource client code

Example responses

200 Response

{
  "clientCode": "string",
  "statusCode": "ACTIVE"
}

Responses

Status Meaning Description Schema
200 OK Successful response ResourceStatus

inland facility

Locations catalog

Search inland facilities

Code samples

# You can also use wget
curl -X GET /api/rest/1.0/inland_facilities \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/inland_facilities',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/rest/1.0/inland_facilities', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /inland_facilities

Parameters

Name In Type Required Description
page query integer false Page
Default: 1
resultsPerPage query integer false Results per page
Default: 25
Maximum: 200
dateModifiedFrom query string(date-time) false Date modified from
Example: 2016-01-16 00:00:00
dateModifiedTo query string(date-time) false Date modified to
Example: 2016-02-16 23:59:59
clientCodes query string false Client codes in JSON format
Example: ["code1","code2"]
Maximum: 200

Example responses

200 Response

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "name": "string",
      "countryCode": "US",
      "geoRegionCode": "string",
      "latitudeDeg": 0,
      "latitudeMin": 0,
      "latitudeSec": 0,
      "latitudeNs": "N",
      "longitudeDeg": 0,
      "longitudeMin": 0,
      "longitudeSec": 0,
      "longitudeWe": "W",
      "statusCode": "ACTIVE",
      "restrictions": "string",
      "generalComments": "string",
      "clientCode": "string",
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful response Locations

Get inland facility detail

Code samples

# You can also use wget
curl -X GET /api/rest/1.0/inland_facilities/{clientCode} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/inland_facilities/{clientCode}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/rest/1.0/inland_facilities/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /inland_facilities/{clientCode}

Parameters

Name In Type Required Description
clientCode path string true Resource client code

Example responses

200 Response

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string",
  "clientCode": "string",
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Responses

Status Meaning Description Schema
200 OK Successful response LocationBase

Create or update an inland facility

Code samples

# You can also use wget
curl -X PUT /api/rest/1.0/inland_facilities/{clientCode} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const inputBody = '{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/rest/1.0/inland_facilities/{clientCode}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/rest/1.0/inland_facilities/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /inland_facilities/{clientCode}

Body parameter

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string"
}

Parameters

Name In Type Required Description
clientCode path string true Resource client code
body body Location true none

Example responses

200 Response

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string"
}

Responses

Status Meaning Description Schema
200 OK Resource Updated Location
201 Created Resource Created Location

Delete or deactivate an inland facility

Code samples

# You can also use wget
curl -X DELETE /api/rest/1.0/inland_facilities/{clientCode} \
  -H 'Accept: application/json'


const headers = {
  'Accept':'application/json'
};

fetch('/api/rest/1.0/inland_facilities/{clientCode}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/rest/1.0/inland_facilities/{clientCode}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /inland_facilities/{clientCode}

Parameters

Name In Type Required Description
clientCode path string true Resource client code

Example responses

200 Response

{
  "clientCode": "string",
  "statusCode": "ACTIVE"
}

Responses

Status Meaning Description Schema
200 OK Successful response ResourceStatus

Schemas

Session

{
  "sessionName": "string",
  "sessionId": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
sessionName string true none Session Name
sessionId string true none Session Id
username string true none Username

Grade

{
  "clientCode": "string",
  "name": "string",
  "gradeTypeCode": "string",
  "description": "string",
  "gradeStatusCode": "ACTIVE",
  "isSensitive": true
}

Properties

Name Type Required Restrictions Description
clientCode string true none Grade client code
name string true none Grade name
gradeTypeCode string true none Grade type
description string true none Grade description
gradeStatusCode string true none Grade status
isSensitive boolean true none Grade is sensitive

Enumerated Values

Property Value
gradeStatusCode ACTIVE
gradeStatusCode INACTIVE

GradeExtra

{
  "clientCode": "string",
  "name": "string",
  "gradeTypeCode": "string",
  "description": "string",
  "gradeStatusCode": "ACTIVE",
  "isSensitive": true,
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous Grade false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» dateCreated string false none Created Date
» creator string false none Creator
» dateModified string false none Modified Date
» modifier string false none Modifier

Grades

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "clientCode": "string",
      "name": "string",
      "gradeTypeCode": "string",
      "description": "string",
      "gradeStatusCode": "ACTIVE",
      "isSensitive": true,
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
totalResultsAvailable integer false none Total Results Available
firstResultPosition integer false none First Result Position
resultsPerPage integer false none Results Per Page
results [GradeExtra] false none Grades

ResourceStatus

{
  "clientCode": "string",
  "statusCode": "ACTIVE"
}

Properties

Name Type Required Restrictions Description
clientCode string true none Client Code
statusCode string true none Status

Enumerated Values

Property Value
statusCode ACTIVE
statusCode INACTIVE

LocationBase

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string",
  "clientCode": "string",
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous Location false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» clientCode string false none Client code
» dateCreated string false none Created Date
» creator string false none Creator
» dateModified string false none Modified Date
» modifier string false none Modifier

Locations

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "name": "string",
      "countryCode": "US",
      "geoRegionCode": "string",
      "latitudeDeg": 0,
      "latitudeMin": 0,
      "latitudeSec": 0,
      "latitudeNs": "N",
      "longitudeDeg": 0,
      "longitudeMin": 0,
      "longitudeSec": 0,
      "longitudeWe": "W",
      "statusCode": "ACTIVE",
      "restrictions": "string",
      "generalComments": "string",
      "clientCode": "string",
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
totalResultsAvailable integer false none Total Results Available
firstResultPosition integer false none First Result Position
resultsPerPage integer false none Results Per Page
results [LocationBase] false none Locations

Location

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string"
}

Properties

Name Type Required Restrictions Description
name string true none Location name
countryCode countryCode true none Country Code
geoRegionCode string true none Geo Region Code
latitudeDeg integer true none Latitude Degree
latitudeMin integer true none Latitude Minute
latitudeSec integer true none Latitude Second
latitudeNs string true none Latitude Hemisphere
longitudeDeg integer true none Longitude Degree
longitudeMin integer true none Longitude Minute
longitudeSec integer true none Longitude Second
longitudeWe string true none Longitude Hemisphere
statusCode string true none Location status code
restrictions string true none Restrictions
generalComments string true none Comments

Enumerated Values

Property Value
latitudeNs N
latitudeNs S
longitudeWe W
longitudeWe E
statusCode ACTIVE
statusCode INACTIVE

countryCode

"US"

Country Code

Properties

Name Type Required Restrictions Description
anonymous string false none Country Code

Enumerated Values

Property Value
anonymous US
anonymous CA
anonymous AX
anonymous AF
anonymous AL
anonymous DZ
anonymous AS
anonymous AD
anonymous AO
anonymous AI
anonymous AQ
anonymous AG
anonymous AR
anonymous AM
anonymous AW
anonymous AU
anonymous AT
anonymous AZ
anonymous BS
anonymous BH
anonymous BD
anonymous BB
anonymous BY
anonymous BE
anonymous BZ
anonymous BJ
anonymous BM
anonymous BT
anonymous BO
anonymous BQ
anonymous BA
anonymous BW
anonymous BV
anonymous BR
anonymous IO
anonymous BN
anonymous BG
anonymous BF
anonymous BI
anonymous KH
anonymous CM
anonymous CV
anonymous KY
anonymous CF
anonymous TD
anonymous CL
anonymous CN
anonymous CX
anonymous CC
anonymous CO
anonymous KM
anonymous CG
anonymous CD
anonymous CK
anonymous CR
anonymous CI
anonymous HR
anonymous CU
anonymous CW
anonymous CY
anonymous CZ
anonymous DK
anonymous DJ
anonymous DM
anonymous DO
anonymous TL
anonymous EC
anonymous EG
anonymous SV
anonymous GQ
anonymous ER
anonymous EE
anonymous ET
anonymous FK
anonymous FO
anonymous FJ
anonymous FI
anonymous FR
anonymous GF
anonymous PF
anonymous TF
anonymous GA
anonymous GM
anonymous GE
anonymous DE
anonymous GH
anonymous GI
anonymous GR
anonymous GL
anonymous GD
anonymous GP
anonymous GU
anonymous GT
anonymous GG
anonymous GN
anonymous GW
anonymous GY
anonymous HT
anonymous HM
anonymous HN
anonymous HK
anonymous HU
anonymous IS
anonymous IN
anonymous ID
anonymous IR
anonymous IQ
anonymous IE
anonymous IM
anonymous IL
anonymous IT
anonymous JM
anonymous JP
anonymous JE
anonymous JO
anonymous KZ
anonymous KE
anonymous KI
anonymous KP
anonymous KR
anonymous KW
anonymous KG
anonymous LA
anonymous LV
anonymous LB
anonymous LS
anonymous LR
anonymous LY
anonymous LI
anonymous LT
anonymous LU
anonymous MO
anonymous MK
anonymous MG
anonymous MW
anonymous MY
anonymous MV
anonymous ML
anonymous MT
anonymous MH
anonymous MQ
anonymous MR
anonymous MU
anonymous YT
anonymous MX
anonymous FM
anonymous MD
anonymous MC
anonymous MN
anonymous ME
anonymous MS
anonymous MA
anonymous MZ
anonymous MM
anonymous NA
anonymous NR
anonymous NP
anonymous NL
anonymous AN
anonymous NC
anonymous NZ
anonymous NI
anonymous NE
anonymous NG
anonymous NU
anonymous NF
anonymous MP
anonymous NO
anonymous OM
anonymous PK
anonymous PW
anonymous PS
anonymous PA
anonymous PG
anonymous PY
anonymous PE
anonymous PH
anonymous PN
anonymous PL
anonymous PT
anonymous PR
anonymous QA
anonymous RE
anonymous RO
anonymous RU
anonymous RW
anonymous WS
anonymous SM
anonymous ST
anonymous SA
anonymous SN
anonymous RS
anonymous SC
anonymous SL
anonymous SG
anonymous SK
anonymous SI
anonymous SB
anonymous SO
anonymous ZA
anonymous GS
anonymous ES
anonymous LK
anonymous BL
anonymous SH
anonymous KN
anonymous LC
anonymous MF
anonymous PM
anonymous VC
anonymous SX
anonymous SD
anonymous SR
anonymous SJ
anonymous SZ
anonymous SE
anonymous CH
anonymous SY
anonymous TW
anonymous TJ
anonymous TZ
anonymous TH
anonymous TG
anonymous TK
anonymous TO
anonymous TT
anonymous TN
anonymous TR
anonymous TM
anonymous TC
anonymous TV
anonymous UG
anonymous UA
anonymous AE
anonymous GB
anonymous UM
anonymous UY
anonymous UZ
anonymous VU
anonymous VA
anonymous VE
anonymous VN
anonymous VG
anonymous VI
anonymous WF
anonymous EH
anonymous YE
anonymous ZM
anonymous ZW

CompanyBase

{
  "clientCode": "string",
  "name": "string",
  "statusCode": "ACTIVE",
  "companyRoles": [
    "string"
  ],
  "headOfficeName": "string",
  "headOfficeDescription": "string",
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Properties

Name Type Required Restrictions Description
clientCode string false none Company client code
name string false none Company name
statusCode string false none Company status code
companyRoles [string] false none Company role
headOfficeName string false none Head office name
headOfficeDescription string false none Head office description
dateCreated string false none Created Date
creator string false none Creator
dateModified string false none Modified Date
modifier string false none Modifier

Enumerated Values

Property Value
statusCode ACTIVE
statusCode INACTIVE

Companies

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "clientCode": "string",
      "name": "string",
      "statusCode": "ACTIVE",
      "companyRoles": [
        "string"
      ],
      "headOfficeName": "string",
      "headOfficeDescription": "string",
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
totalResultsAvailable integer false none Total Results Available
firstResultPosition integer false none First Result Position
resultsPerPage integer false none Results Per Page
results [CompanyBase] false none Companies

Company

{
  "name": "string",
  "headOffice": {
    "name": "string",
    "description": "string",
    "contact": {
      "addresses": [
        {
          "isPreferred": true,
          "address": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "countryCode": "US",
          "addressTypeCode": "WORK"
        }
      ],
      "emails": [
        {
          "isPreferred": true,
          "address": "string",
          "emailTypeCode": "WORK"
        }
      ],
      "urls": [
        {
          "isPreferred": true,
          "address": "string",
          "urlTypeCode": "WORK"
        }
      ],
      "phones": [
        {
          "isPreferred": true,
          "phoneNumber": "string",
          "phoneTypeCode": "WORK"
        }
      ]
    }
  }
}

Properties

Name Type Required Restrictions Description
name string true none Company name
headOffice Office true none none

Office

{
  "name": "string",
  "description": "string",
  "contact": {
    "addresses": [
      {
        "isPreferred": true,
        "address": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "countryCode": "US",
        "addressTypeCode": "WORK"
      }
    ],
    "emails": [
      {
        "isPreferred": true,
        "address": "string",
        "emailTypeCode": "WORK"
      }
    ],
    "urls": [
      {
        "isPreferred": true,
        "address": "string",
        "urlTypeCode": "WORK"
      }
    ],
    "phones": [
      {
        "isPreferred": true,
        "phoneNumber": "string",
        "phoneTypeCode": "WORK"
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
name string true none none
description string true none none
contact Contact true none none

Contact

{
  "addresses": [
    {
      "isPreferred": true,
      "address": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "US",
      "addressTypeCode": "WORK"
    }
  ],
  "emails": [
    {
      "isPreferred": true,
      "address": "string",
      "emailTypeCode": "WORK"
    }
  ],
  "urls": [
    {
      "isPreferred": true,
      "address": "string",
      "urlTypeCode": "WORK"
    }
  ],
  "phones": [
    {
      "isPreferred": true,
      "phoneNumber": "string",
      "phoneTypeCode": "WORK"
    }
  ]
}

Properties

Name Type Required Restrictions Description
addresses [Address] true none none
emails [Email] true none none
urls [Url] true none none
phones [Phone] true none none

Address

{
  "isPreferred": true,
  "address": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "US",
  "addressTypeCode": "WORK"
}

Properties

Name Type Required Restrictions Description
isPreferred boolean true none none
address string true none none
city string true none none
state string true none none
postalCode string true none none
countryCode countryCode true none Country Code
addressTypeCode AddressType true none none

Url

{
  "isPreferred": true,
  "address": "string",
  "urlTypeCode": "WORK"
}

Properties

Name Type Required Restrictions Description
isPreferred boolean true none none
address string true none none
urlTypeCode UrlType true none none

Phone

{
  "isPreferred": true,
  "phoneNumber": "string",
  "phoneTypeCode": "WORK"
}

Properties

Name Type Required Restrictions Description
isPreferred boolean true none none
phoneNumber string true none none
phoneTypeCode PhoneType true none none

Email

{
  "isPreferred": true,
  "address": "string",
  "emailTypeCode": "WORK"
}

Properties

Name Type Required Restrictions Description
isPreferred boolean true none none
address string true none none
emailTypeCode EmailType true none none

AddressType

"WORK"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous WORK
anonymous HOME
anonymous MAIN
anonymous MAILING
anonymous OTHER

EmailType

"WORK"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous WORK
anonymous HOME
anonymous OTHER
anonymous NOL
anonymous OFF_SPEC
anonymous SCORECARD
anonymous VEF_REPORT

PhoneType

"WORK"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous WORK
anonymous HOME
anonymous MOBILE
anonymous PAGER
anonymous WORKFAX
anonymous HOMEFAX
anonymous MAIN
anonymous AFTERHRS1
anonymous AFTERHRS2
anonymous AFTERHRS3
anonymous HOTLINE
anonymous SAT - A/B
anonymous SAT - C
anonymous TELEX
anonymous REUTERS
anonymous CARPHONE
anonymous CALLSIGN
anonymous PHONE

UrlType

"WORK"

Properties

Name Type Required Restrictions Description
anonymous string false none none

Enumerated Values

Property Value
anonymous WORK
anonymous HOME
anonymous BLOG
anonymous OTHER