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": "be0544bb-4daf-4388-b840-79ad6d7bf179", "Name": "sample string 2", "Code": "sample string 3", "Abbreviation": "sample string 4", "Active": true, "Exempt": true, "TrustArcFormId": "27817815-0b1d-4be0-8ec6-948e9bc27855", "ClientSystemId": "ee180527-2abb-4b1e-9957-1a9e1deacc9f", "IDologyEnterpriseId": "9306eedf-efaf-4699-90dd-05d3059ee7cd", "SubCategoryId": "2157090b-e154-4134-a2a1-06bf89e8dcaa", "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>ee180527-2abb-4b1e-9957-1a9e1deacc9f</ClientSystemId> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>9306eedf-efaf-4699-90dd-05d3059ee7cd</IDologyEnterpriseId> <ModifiedBy>sample string 7</ModifiedBy> <Name>sample string 2</Name> <SubCategoryId>2157090b-e154-4134-a2a1-06bf89e8dcaa</SubCategoryId> <TrustArcFormId>27817815-0b1d-4be0-8ec6-948e9bc27855</TrustArcFormId> <Id>be0544bb-4daf-4388-b840-79ad6d7bf179</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>