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": "dfa22a3b-df00-4f12-b715-669da6875613", "ClientSystemId": "4d118410-9297-4cef-a384-047b49dcf159", "IDologyEnterpriseId": "e6c718ad-f43e-4740-99f8-089f65bafd03", "SubCategoryId": "8b94112c-3c0d-4638-a1db-3ba88b76e1e6", "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>4d118410-9297-4cef-a384-047b49dcf159</ClientSystemId> <Code>sample string 2</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>e6c718ad-f43e-4740-99f8-089f65bafd03</IDologyEnterpriseId> <ModifiedBy>sample string 6</ModifiedBy> <Name>sample string 1</Name> <SubCategoryId>8b94112c-3c0d-4638-a1db-3ba88b76e1e6</SubCategoryId> <TrustArcFormId>dfa22a3b-df00-4f12-b715-669da6875613</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>