GET api/Product/{id}

Returns a specific product.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The Product ID

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

A product that may or may not be inactive.

ProductModel
NameDescriptionTypeAdditional information
Id

Product's unique identifier.

globally unique identifier

None.

Name

The product name as the user will see it.

string

None.

Code

Product code.

string

None.

Abbreviation

Not really sure, for the most part it looks the same as Name.

string

None.

Active

Only active products shown to end users. Required.

boolean

None.

Exempt

Exempt products don't apply to CCPa law. Required.

boolean

None.

TrustArcForm

SupportObjModel

None.

ClientSystem

SupportObjModel

None.

IDologyEnterprise

SupportObjModel

None.

SubCategory

SupportObjModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "86d06153-88c3-4ae6-8024-651ebc2ad1d7",
  "Name": "sample string 2",
  "Code": "sample string 3",
  "Abbreviation": "sample string 4",
  "Active": true,
  "Exempt": true,
  "TrustArcForm": {
    "Id": "39735d0b-e84e-4798-89c6-b6ef5c7fb4d3",
    "Name": "sample string 2",
    "Code": "sample string 3",
    "Active": true
  },
  "ClientSystem": {
    "Id": "39735d0b-e84e-4798-89c6-b6ef5c7fb4d3",
    "Name": "sample string 2",
    "Code": "sample string 3",
    "Active": true
  },
  "IDologyEnterprise": {
    "Id": "39735d0b-e84e-4798-89c6-b6ef5c7fb4d3",
    "Name": "sample string 2",
    "Code": "sample string 3",
    "Active": true
  },
  "SubCategory": {
    "Id": "39735d0b-e84e-4798-89c6-b6ef5c7fb4d3",
    "Name": "sample string 2",
    "Code": "sample string 3",
    "Active": true
  }
}

text/xml

Sample:
<ProductModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Product">
  <Abbreviation>sample string 4</Abbreviation>
  <Active>true</Active>
  <ClientSystem xmlns:d2p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:Code>sample string 3</d2p1:Code>
    <d2p1:Id>39735d0b-e84e-4798-89c6-b6ef5c7fb4d3</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </ClientSystem>
  <Code>sample string 3</Code>
  <Exempt>true</Exempt>
  <IDologyEnterprise xmlns:d2p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:Code>sample string 3</d2p1:Code>
    <d2p1:Id>39735d0b-e84e-4798-89c6-b6ef5c7fb4d3</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </IDologyEnterprise>
  <Id>86d06153-88c3-4ae6-8024-651ebc2ad1d7</Id>
  <Name>sample string 2</Name>
  <SubCategory xmlns:d2p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:Code>sample string 3</d2p1:Code>
    <d2p1:Id>39735d0b-e84e-4798-89c6-b6ef5c7fb4d3</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </SubCategory>
  <TrustArcForm xmlns:d2p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:Code>sample string 3</d2p1:Code>
    <d2p1:Id>39735d0b-e84e-4798-89c6-b6ef5c7fb4d3</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </TrustArcForm>
</ProductModel>