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": "a6d34937-c91a-4824-a44a-c3a8a1a4f8bd", "Name": "sample string 2", "Code": "sample string 3", "Abbreviation": "sample string 4", "Active": true, "Exempt": true, "TrustArcFormId": "a888af79-4d24-49a9-8f5a-ac94d748210d", "ClientSystemId": "2486ca0a-2795-4dac-b704-a25ebfff5773", "IDologyEnterpriseId": "79ceae6b-c983-45a2-8b61-0d08daf59fe3", "SubCategoryId": "984fc72d-fa27-4b3d-828c-5e880d4fb976", "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>2486ca0a-2795-4dac-b704-a25ebfff5773</ClientSystemId> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>79ceae6b-c983-45a2-8b61-0d08daf59fe3</IDologyEnterpriseId> <ModifiedBy>sample string 7</ModifiedBy> <Name>sample string 2</Name> <SubCategoryId>984fc72d-fa27-4b3d-828c-5e880d4fb976</SubCategoryId> <TrustArcFormId>a888af79-4d24-49a9-8f5a-ac94d748210d</TrustArcFormId> <Id>a6d34937-c91a-4824-a44a-c3a8a1a4f8bd</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>