POST api/Product
Create a product.
Request Information
URI Parameters
None.
Body Parameters
CreateProductModel| Name | 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": "b6c040bb-a3fc-4cd8-ad6a-0a26ebd73702",
"ClientSystemId": "aab071df-c3d1-4f3a-b086-5663d48581e5",
"IDologyEnterpriseId": "da8caa50-55eb-453d-af2b-b76484152f2a",
"SubCategoryId": "ca768f7f-81bc-4594-bc81-679750f63017",
"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>aab071df-c3d1-4f3a-b086-5663d48581e5</ClientSystemId> <Code>sample string 2</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>da8caa50-55eb-453d-af2b-b76484152f2a</IDologyEnterpriseId> <ModifiedBy>sample string 6</ModifiedBy> <Name>sample string 1</Name> <SubCategoryId>ca768f7f-81bc-4594-bc81-679750f63017</SubCategoryId> <TrustArcFormId>b6c040bb-a3fc-4cd8-ad6a-0a26ebd73702</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>