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": "d8a87b9a-1227-4f20-8544-31ad607c458d",
"Name": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"Active": true,
"Exempt": true,
"TrustArcFormId": "95d51891-8ea5-4b41-aa65-e890fb30907f",
"ClientSystemId": "5f30f4a4-6d8b-4879-9b21-0fe3237dbdf2",
"IDologyEnterpriseId": "2757f60e-2494-4a2e-b570-1a101c9a642a",
"SubCategoryId": "4e192287-02fc-4232-815a-12ac7093d5f0",
"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>5f30f4a4-6d8b-4879-9b21-0fe3237dbdf2</ClientSystemId> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>2757f60e-2494-4a2e-b570-1a101c9a642a</IDologyEnterpriseId> <ModifiedBy>sample string 7</ModifiedBy> <Name>sample string 2</Name> <SubCategoryId>4e192287-02fc-4232-815a-12ac7093d5f0</SubCategoryId> <TrustArcFormId>95d51891-8ea5-4b41-aa65-e890fb30907f</TrustArcFormId> <Id>d8a87b9a-1227-4f20-8544-31ad607c458d</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>