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": "20dd7400-5096-47da-a6b4-ff4689286d68", "ClientSystemId": "cc793061-db8a-4b17-9c46-a0d3eadf2de0", "IDologyEnterpriseId": "64a29f91-f4e9-4a57-b5d5-2f92d5fbca05", "SubCategoryId": "c3ec79d1-1cd0-497f-8151-791e64a6bd1d", "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>cc793061-db8a-4b17-9c46-a0d3eadf2de0</ClientSystemId> <Code>sample string 2</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>64a29f91-f4e9-4a57-b5d5-2f92d5fbca05</IDologyEnterpriseId> <ModifiedBy>sample string 6</ModifiedBy> <Name>sample string 1</Name> <SubCategoryId>c3ec79d1-1cd0-497f-8151-791e64a6bd1d</SubCategoryId> <TrustArcFormId>20dd7400-5096-47da-a6b4-ff4689286d68</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>