GET api/Product/{id}
Returns a specific product.
Request Information
URI Parameters
| Name | Description | Type | Additional 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| Name | Description | Type | Additional 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": "98f47ef4-c16a-43c2-ba6b-c8e616a34a2c",
"Name": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"Active": true,
"Exempt": true,
"TrustArcForm": {
"Id": "e36da896-0240-4203-b20f-a0d9735f5a65",
"Name": "sample string 2",
"Code": "sample string 3",
"Active": true
},
"ClientSystem": {
"Id": "e36da896-0240-4203-b20f-a0d9735f5a65",
"Name": "sample string 2",
"Code": "sample string 3",
"Active": true
},
"IDologyEnterprise": {
"Id": "e36da896-0240-4203-b20f-a0d9735f5a65",
"Name": "sample string 2",
"Code": "sample string 3",
"Active": true
},
"SubCategory": {
"Id": "e36da896-0240-4203-b20f-a0d9735f5a65",
"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>e36da896-0240-4203-b20f-a0d9735f5a65</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>e36da896-0240-4203-b20f-a0d9735f5a65</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</IDologyEnterprise>
<Id>98f47ef4-c16a-43c2-ba6b-c8e616a34a2c</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>e36da896-0240-4203-b20f-a0d9735f5a65</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>e36da896-0240-4203-b20f-a0d9735f5a65</d2p1:Id>
<d2p1:Name>sample string 2</d2p1:Name>
</TrustArcForm>
</ProductModel>