POST api/Product
Create a product.
Request Information
URI Parameters
None.
Body Parameters
CreateProductModelName | Description | Type | Additional information |
---|---|---|---|
Name |
The product name as the user will see it. |
string |
Required |
Code |
I don't know! |
string |
Required |
Abbreviation |
Not really sure, for the most part it looks the same as Name. |
string |
Required |
Active |
Only active products shown to end users. Required. |
boolean |
Required |
Exempt |
Exempt products don't apply to CCPa law. Required. |
boolean |
Required |
TrustArcFormId |
Not required. |
globally unique identifier |
None. |
ClientSystemId |
Required. |
globally unique identifier |
Required |
IDologyEnterpriseId |
Required. |
globally unique identifier |
Required |
SubCategoryId |
Not required. |
globally unique identifier |
None. |
ModifiedBy |
An identifier for the user that altered this product. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "Name": "sample string 1", "Code": "sample string 2", "Abbreviation": "sample string 3", "Active": true, "Exempt": true, "TrustArcFormId": "fcb068fd-71ca-4238-9d3f-a70549d7dca8", "ClientSystemId": "bea34381-8d28-4592-86a7-cde55120821c", "IDologyEnterpriseId": "1dab340b-ef8e-480e-a752-617a89b945bb", "SubCategoryId": "60f2a643-f4e2-4567-81df-2b0ee516149e", "ModifiedBy": "sample string 6" }
text/xml
Sample:
<CreateProductModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Product"> <Abbreviation>sample string 3</Abbreviation> <Active>true</Active> <ClientSystemId>bea34381-8d28-4592-86a7-cde55120821c</ClientSystemId> <Code>sample string 2</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>1dab340b-ef8e-480e-a752-617a89b945bb</IDologyEnterpriseId> <ModifiedBy>sample string 6</ModifiedBy> <Name>sample string 1</Name> <SubCategoryId>60f2a643-f4e2-4567-81df-2b0ee516149e</SubCategoryId> <TrustArcFormId>fcb068fd-71ca-4238-9d3f-a70549d7dca8</TrustArcFormId> </CreateProductModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
booleanResponse Formats
application/json, text/json
Sample:
true
text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>