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": "d51a4aee-e9a4-4b96-80c7-af3118cb6d42",
"Name": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"Active": true,
"Exempt": true,
"TrustArcFormId": "20756080-dd86-4167-a858-b6b0e420c743",
"ClientSystemId": "6d6c51f5-0580-4c52-9516-df7fcfb9aa91",
"IDologyEnterpriseId": "fc9a85c2-71df-474e-a10e-7fb932537a61",
"SubCategoryId": "6757f56e-ec58-4ea4-b3e4-af87c59161eb",
"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>6d6c51f5-0580-4c52-9516-df7fcfb9aa91</ClientSystemId> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>fc9a85c2-71df-474e-a10e-7fb932537a61</IDologyEnterpriseId> <ModifiedBy>sample string 7</ModifiedBy> <Name>sample string 2</Name> <SubCategoryId>6757f56e-ec58-4ea4-b3e4-af87c59161eb</SubCategoryId> <TrustArcFormId>20756080-dd86-4167-a858-b6b0e420c743</TrustArcFormId> <Id>d51a4aee-e9a4-4b96-80c7-af3118cb6d42</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>