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": "dbb4ab53-3d60-4202-b5eb-6c05282d1de2",
"Name": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"Active": true,
"Exempt": true,
"TrustArcFormId": "47274c68-d18c-4cd3-85a7-c53235f5caed",
"ClientSystemId": "770b593c-b091-4a68-aa08-9790a1e846a2",
"IDologyEnterpriseId": "f1906c62-6c1f-4248-90c1-f3b6cd425c0b",
"SubCategoryId": "12d05981-b4a1-48f4-9037-eaeeb78ec1ac",
"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>770b593c-b091-4a68-aa08-9790a1e846a2</ClientSystemId> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>f1906c62-6c1f-4248-90c1-f3b6cd425c0b</IDologyEnterpriseId> <ModifiedBy>sample string 7</ModifiedBy> <Name>sample string 2</Name> <SubCategoryId>12d05981-b4a1-48f4-9037-eaeeb78ec1ac</SubCategoryId> <TrustArcFormId>47274c68-d18c-4cd3-85a7-c53235f5caed</TrustArcFormId> <Id>dbb4ab53-3d60-4202-b5eb-6c05282d1de2</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>