GET api/v1/engine/info

Returns basic information about the API.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Info
NameDescriptionTypeAdditional information
Title

The title of the application.

string

None.

Description

A short description of the application.

string

None.

Version

The version of the application.

string

None.

SolutionAssemblies

The list of main assemblies of the solution.

Dictionary of string [key] and string [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "title": "TranspariX Engine API",
  "description": "The TX Engine is a core component of the Logistyx Transportation Management Execution (TME) system. It makes it possible to find and compare diverse forwarder service alternatives.",
  "version": "1.20.7.61",
  "solutionAssemblies": {
    "transpariX.Engine.WebAPI": "1.20.7.61",
    "transpariX.Engine.DataClasses": "1.20.7.2",
    "transpariX.Engine.v7": "7.20.6.111",
    "transpariX.Engine.DefinitiveCodes": "1.20.5.26",
    "transpariX.Engine.UOMs": "1.20.6.11"
  }
}

application/xml, text/xml

Sample:
<EngineController.Info xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TranspariX.Engine.WebAPI.Controllers">
  <SolutionAssemblies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>TranspariX.Engine.WebAPI</d2p1:Key>
      <d2p1:Value>1.20.7.61</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>TranspariX.Engine.DataClasses</d2p1:Key>
      <d2p1:Value>1.20.7.2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>TranspariX.Engine.v7</d2p1:Key>
      <d2p1:Value>7.20.6.111</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>TranspariX.Engine.DefinitiveCodes</d2p1:Key>
      <d2p1:Value>1.20.5.26</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>TranspariX.Engine.UOMs</d2p1:Key>
      <d2p1:Value>1.20.6.11</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </SolutionAssemblies>
</EngineController.Info>