GET api/Products
Returns all products. Filter on your own if you only want active.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Returns all products regardless if they are active or inactive.
Collection of ProductModelName | 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": "0cb0f848-7761-46d9-b90e-1bf2e91a21b4", "Name": "sample string 2", "Code": "sample string 3", "Abbreviation": "sample string 4", "Active": true, "Exempt": true, "TrustArcForm": { "Id": "0c5c2fc4-dffb-424a-a418-574e47fe50c3", "Name": "sample string 2", "Code": "sample string 3", "Active": true }, "ClientSystem": { "Id": "0c5c2fc4-dffb-424a-a418-574e47fe50c3", "Name": "sample string 2", "Code": "sample string 3", "Active": true }, "IDologyEnterprise": { "Id": "0c5c2fc4-dffb-424a-a418-574e47fe50c3", "Name": "sample string 2", "Code": "sample string 3", "Active": true }, "SubCategory": { "Id": "0c5c2fc4-dffb-424a-a418-574e47fe50c3", "Name": "sample string 2", "Code": "sample string 3", "Active": true } }, { "Id": "0cb0f848-7761-46d9-b90e-1bf2e91a21b4", "Name": "sample string 2", "Code": "sample string 3", "Abbreviation": "sample string 4", "Active": true, "Exempt": true, "TrustArcForm": { "Id": "0c5c2fc4-dffb-424a-a418-574e47fe50c3", "Name": "sample string 2", "Code": "sample string 3", "Active": true }, "ClientSystem": { "Id": "0c5c2fc4-dffb-424a-a418-574e47fe50c3", "Name": "sample string 2", "Code": "sample string 3", "Active": true }, "IDologyEnterprise": { "Id": "0c5c2fc4-dffb-424a-a418-574e47fe50c3", "Name": "sample string 2", "Code": "sample string 3", "Active": true }, "SubCategory": { "Id": "0c5c2fc4-dffb-424a-a418-574e47fe50c3", "Name": "sample string 2", "Code": "sample string 3", "Active": true } } ]
text/xml
Sample:
<ArrayOfProductModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Product"> <ProductModel> <Abbreviation>sample string 4</Abbreviation> <Active>true</Active> <ClientSystem xmlns:d3p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common"> <d3p1:Active>true</d3p1:Active> <d3p1:Code>sample string 3</d3p1:Code> <d3p1:Id>0c5c2fc4-dffb-424a-a418-574e47fe50c3</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </ClientSystem> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterprise xmlns:d3p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common"> <d3p1:Active>true</d3p1:Active> <d3p1:Code>sample string 3</d3p1:Code> <d3p1:Id>0c5c2fc4-dffb-424a-a418-574e47fe50c3</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </IDologyEnterprise> <Id>0cb0f848-7761-46d9-b90e-1bf2e91a21b4</Id> <Name>sample string 2</Name> <SubCategory xmlns:d3p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common"> <d3p1:Active>true</d3p1:Active> <d3p1:Code>sample string 3</d3p1:Code> <d3p1:Id>0c5c2fc4-dffb-424a-a418-574e47fe50c3</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </SubCategory> <TrustArcForm xmlns:d3p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common"> <d3p1:Active>true</d3p1:Active> <d3p1:Code>sample string 3</d3p1:Code> <d3p1:Id>0c5c2fc4-dffb-424a-a418-574e47fe50c3</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </TrustArcForm> </ProductModel> <ProductModel> <Abbreviation>sample string 4</Abbreviation> <Active>true</Active> <ClientSystem xmlns:d3p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common"> <d3p1:Active>true</d3p1:Active> <d3p1:Code>sample string 3</d3p1:Code> <d3p1:Id>0c5c2fc4-dffb-424a-a418-574e47fe50c3</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </ClientSystem> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterprise xmlns:d3p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common"> <d3p1:Active>true</d3p1:Active> <d3p1:Code>sample string 3</d3p1:Code> <d3p1:Id>0c5c2fc4-dffb-424a-a418-574e47fe50c3</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </IDologyEnterprise> <Id>0cb0f848-7761-46d9-b90e-1bf2e91a21b4</Id> <Name>sample string 2</Name> <SubCategory xmlns:d3p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common"> <d3p1:Active>true</d3p1:Active> <d3p1:Code>sample string 3</d3p1:Code> <d3p1:Id>0c5c2fc4-dffb-424a-a418-574e47fe50c3</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </SubCategory> <TrustArcForm xmlns:d3p1="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Common"> <d3p1:Active>true</d3p1:Active> <d3p1:Code>sample string 3</d3p1:Code> <d3p1:Id>0c5c2fc4-dffb-424a-a418-574e47fe50c3</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </TrustArcForm> </ProductModel> </ArrayOfProductModel>