Approve Product

This operation changes the Product status from Test to Approved. The change in status shows that the Product is ready for loading into the Claims environment.

Only a Product in the Test status has the Approved status.

Resource Representation

The approve link determines whether Product status can change to Approved.

The following is a resource representation of a Product that has an updatable status:

{
  ... Product properties ...
  "links": [
    {
      "http://<host>:<port>/generic/products/{id}",
      "rel": "self"
    },
    {
      "http://<host>:<port>/products/{id}/approve",
      "rel": "product:approve",
      "httpMethod": "PUT"
    }
  ]
}

The following is a resource representation of a Product that cannot be changed to Approved status. For example, when the Product is already in Approved or Edit status:

{
  ... Product properties ...
  "links": [
    {
      "http://<host>:<port>/generic/products/{id}",
      "rel": "self"
    }
  ]
}

Response Messages

Following are the messages the operation returns:

Success

A successful operation returns HTTP 200 OK response.

Failure

If an error occurs, the operation returns an appropriate HTTP status code. See Response Messages for more information.

The following message appears when the operation encounters an error:

Table 1. Failure
Code Severity Message Text

PRD-HTTP-005

Fatal

To change the product status to Approved, the product must be in a status Test.

Authorization

The products.approve IP access restriction protects the operation.