PUT api/Product
Updates a product.
Request Information
URI Parameters
None.
Body Parameters
UpdateProductModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Product's unique identifier. Only used to find the product, not to be updated. |
globally unique identifier |
None. |
| 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:
{
"Id": "1ec47e2e-571b-451d-aa58-510a92ae7937",
"Name": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"Active": true,
"Exempt": true,
"TrustArcFormId": "980c15b1-79c2-49de-8030-5a9e3b636add",
"ClientSystemId": "0c459946-3650-4558-ae2e-b9d73e283447",
"IDologyEnterpriseId": "de0ec422-5d9c-4972-a8ac-3dbcd4ca185a",
"SubCategoryId": "752298f5-3d17-4c45-80fe-77451a545801",
"ModifiedBy": "sample string 7"
}
text/xml
Sample:
<UpdateProductModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Privacy.Proc.API.Models.Product"> <Abbreviation>sample string 4</Abbreviation> <Active>true</Active> <ClientSystemId>0c459946-3650-4558-ae2e-b9d73e283447</ClientSystemId> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>de0ec422-5d9c-4972-a8ac-3dbcd4ca185a</IDologyEnterpriseId> <ModifiedBy>sample string 7</ModifiedBy> <Name>sample string 2</Name> <SubCategoryId>752298f5-3d17-4c45-80fe-77451a545801</SubCategoryId> <TrustArcFormId>980c15b1-79c2-49de-8030-5a9e3b636add</TrustArcFormId> <Id>1ec47e2e-571b-451d-aa58-510a92ae7937</Id> </UpdateProductModel>
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>