List products per reporting group

get

https://{hostname}/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.

Path Params

reportingGroupId

integer

required

The unique identifier for a Content Provider (CP) code reporting group.

Query Params

from

string

length between 10 and 10

The start date, in UTC, to use when looking for products associated with a contract. The search always begins at midnight (0:00) UTC of the specified date. The default start date is 30 days prior to the current date. For current contracts, you can select a date within the past 15 months of the current date. For expired contracts, you are limited to a date range of 30 days within the 15 month window.

string

length between 10 and 10

The end date, in UTC, to use when looking for products associated with a contract. The search always ends at 23:59:59 UTC of the specified date. The default end date is the current date.

accountSwitchKey

string

Runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The response provides a list of products. This response is returned when the CP code reporting group is associated with only one contract.

300The request returned a list of matching contracts because the CP code reporting group is associated with multiple contracts. To retrieve product information, make a new GET request to a specific contract ID using the API listed in the response.

400Bad request.

401Unauthorized error.

403Access is forbidden.

404Resource not found.