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": "420af115-b539-4238-95b6-cf907958fcfc",
"Name": "sample string 2",
"Code": "sample string 3",
"Abbreviation": "sample string 4",
"Active": true,
"Exempt": true,
"TrustArcFormId": "97720aae-0c65-491b-aa3c-b65b5ad382de",
"ClientSystemId": "fe59b269-7ada-4975-a2ce-48c563ca57a7",
"IDologyEnterpriseId": "c6c18eda-ecbf-4463-96b4-e2aa1a346441",
"SubCategoryId": "621de5c6-b160-43f5-b2b6-d202301c1823",
"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>fe59b269-7ada-4975-a2ce-48c563ca57a7</ClientSystemId> <Code>sample string 3</Code> <Exempt>true</Exempt> <IDologyEnterpriseId>c6c18eda-ecbf-4463-96b4-e2aa1a346441</IDologyEnterpriseId> <ModifiedBy>sample string 7</ModifiedBy> <Name>sample string 2</Name> <SubCategoryId>621de5c6-b160-43f5-b2b6-d202301c1823</SubCategoryId> <TrustArcFormId>97720aae-0c65-491b-aa3c-b65b5ad382de</TrustArcFormId> <Id>420af115-b539-4238-95b6-cf907958fcfc</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>