Retrieve a program by Program Group
Retrieve configuration for a specific program associated with a program group. You can optionally specify localeId to only retrieve text tags for the specified locale.
This call will return the default preference values for the Filters as defined in the specified program group.
Header Parameters
Authorizationstring Required
Authorization token
Content-Typestring
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Query Parameters
localestring
A valid locale ID associated with a text tag. If specified, the API response will only include text tags for the specified locale.
Path Parameters
clientIdstring
This is your MyPreferences Account Id.
programGroupIdstring
Id of the program group that contains the program.
programIdstring
Id of the program that's associated with the specified program group.
Response
200
Object
The request was successfully processed.
Response Attributes
Programsarray
The collection of programs.
Show child attributes
400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
Response Attributes
Messagestring
Nullable:
True
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
Response Attributes
Messagestring
Nullable:
True
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
Response Attributes
Messagestring
Nullable:
True
404
Object
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found.
Response Attributes
Messagestring
Nullable:
True
503
Object
The server is unable to handle your request due to a temporary condition. You must delay your request for some time before trying again. Notify PossibleNOW Support if it’s a continuous occurrence.
Response Attributes
Messagestring
Nullable:
True
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?