PUT api/Product
Updates a product.
Request Information
URI Parameters
None.
Body Parameters
UpdateProductModelName | 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": "e2d581ba-cd3e-409a-9803-ccc4fa6cb1ba", "Name": "sample string 2", "Code": "sample string 3", "Abbreviation": "sample string 4", "Active": true, "Exempt": true, "TrustArcFormId": "543be033-9175-4de8-9b48-6acc427a9768", "ClientSystemId": "8e7560ed-19e1-482e-bb47-bc8f78ff0fa2", "IDologyEnterpriseId": "ccbc9e0e-0ef7-4c18-a0ab-fc9aa9efa7f9", "SubCategoryId": "e36785aa-3e6b-4498-9422-b2610f8644ae", "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>8e7560ed-19e1-482e-bb47-bc8f78ff0fa2</ClientSystemId> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>ccbc9e0e-0ef7-4c18-a0ab-fc9aa9efa7f9</IDologyEnterpriseId> <ModifiedBy>sample string 7</ModifiedBy> <Name>sample string 2</Name> <SubCategoryId>e36785aa-3e6b-4498-9422-b2610f8644ae</SubCategoryId> <TrustArcFormId>543be033-9175-4de8-9b48-6acc427a9768</TrustArcFormId> <Id>e2d581ba-cd3e-409a-9803-ccc4fa6cb1ba</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>