GET v1/integration/products

Returns a list of the valid products for the current Integration. A product represents a specific configuration of and Asavie network along with any parameters that are required to do the configuration. Depending on requirement Asavie can create custom Products for an Integration that have all the required defaults in place so that no parameters are required to be passed in

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

List of Products. If none exists then an empty list is returned

PBPRReturnOfListOfProduct
NameDescriptionTypeAdditional information
Data

Collection of Product

None.

Success

Gets the success status of the API call

boolean

None.

Meta

Gets the optional meta-data

Dictionary of string [key] and string [value]

None.

Code

Get the http code of the API call e.g. 200, 202, 409

integer

None.

ErrorCode

Get the failure error code of the API call. This is available if Success is false

integer

None.

ErrorSubCode

Gets the error sub code if available

integer

None.

ErrorDescription

Gets a textual description of the error

string

None.

StatusUrl

Gets the status url for any ACCEPTed API commands. Any command (POST,DELETE,PATCh,PUT) to the API usually returns a 202 response code. The status of the command can be queried using the URL provided

string

None.

ContinuationToken

Gets the token to be used for paged queries

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Meta": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Code": 2,
  "ErrorCode": 3,
  "Data": [
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Settings": [
        {
          "Key": "sample string 1",
          "SettingType": 0,
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "SettingType": 0,
          "Value": "sample string 2"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Settings": [
        {
          "Key": "sample string 1",
          "SettingType": 0,
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "SettingType": 0,
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "ErrorSubCode": 4,
  "ErrorDescription": "sample string 5",
  "StatusUrl": "sample string 6",
  "ContinuationToken": "3siZhMzd8IynlMrCw4mfrQ%3D%3D"
}

application/xml, text/xml

Sample:
<PBPRReturnOfArrayOfProduct7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Code>2</Code>
  <ContinuationToken>3siZhMzd8IynlMrCw4mfrQ%3D%3D</ContinuationToken>
  <ErrorCode>3</ErrorCode>
  <ErrorDescription>sample string 5</ErrorDescription>
  <ErrorSubCode>4</ErrorSubCode>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <StatusUrl>sample string 6</StatusUrl>
  <Success>true</Success>
  <Data>
    <Product>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <Settings xmlns:d4p1="http://schemas.datacontract.org/2004/07/AS.Interfaces.Models">
        <d4p1:Setting>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:SettingType>ipaddress</d4p1:SettingType>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:Setting>
        <d4p1:Setting>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:SettingType>ipaddress</d4p1:SettingType>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:Setting>
      </Settings>
    </Product>
    <Product>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <Settings xmlns:d4p1="http://schemas.datacontract.org/2004/07/AS.Interfaces.Models">
        <d4p1:Setting>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:SettingType>ipaddress</d4p1:SettingType>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:Setting>
        <d4p1:Setting>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:SettingType>ipaddress</d4p1:SettingType>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:Setting>
      </Settings>
    </Product>
  </Data>
</PBPRReturnOfArrayOfProduct7NMnQmOk>