Products

Number of APIs: 2

1. List products per contract

GET https://{{host}}/contract-api/v1/contracts/:contractId/products/summaries

Get the IDs and names of the products associated with a contract for the time frame selected.

---

2. List products per reporting group

GET https://{{host}}/contract-api/v1/reportingGroups/:reportingGroupId/products/summaries

Get the IDs and names of the products associated with the reporting group for the time frame selected. To run this operation, your user account needs the CPCode Rep Group role. To add this role, use the Identity and Access Management application. When a request is successful, it may return either a 200 or a 300 response. The API returns a 200 (OK) response when the CP code reporting group is associated with only one contract. You'll receive a 300 Multiple Choices response when the request returns a list of matching contracts because the CP code reporting group is associated with multiple contracts. To retrieve product information when you receive a 300 response code, make a new GET request to the hyperlinks provided in the response.

---