GET {clientId}/Consents/{profileId}/Filters?filterId={filterId}&implied={implied}

This method allows you to retrieve consents for specific filters for a profile

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	This is your organization’s MyPreferences account Id.	string	Required
profileId	Id of the Profile for which you want to retrieve Filter and Consent associations.	integer	Required
filterId	Optional parameter to limit the result set for a specific Filter. If not included, consent associations for all Filters will be returned.	string
implied	If true, both implied and expressed preference associations are returned. If false, only expressed preference associations are returned.	boolean	Default value is False

Body Parameters

None.

Response Information

Response Codes

HTTP Status Code	Text	Description
200	OK	The request was successfully processed.
400	Bad Request	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.
401	Unauthorized	Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403	Forbidden	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.
404	Not Found	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. See error description for more details.
500	Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.

Resource Description

ConsentFilterList

Name	Description	Type	Additional information
ConsentFilters	A collection of ConsentFilters to be associated with ConsentVersionIds	Collection of ConsentFilter

Response Formats

application/json, text/json, application/json-patch+json

Sample:

{
  "ConsentFilters": [
    {
      "FilterId": "sample string 1",
      "TypeName": "sample string 2",
      "Implied": true,
      "Consents": [
        {
          "ConsentType": "sample string 1",
          "ConsentVersion": "sample string 2"
        },
        {
          "ConsentType": "sample string 1",
          "ConsentVersion": "sample string 2"
        }
      ]
    },
    {
      "FilterId": "sample string 1",
      "TypeName": "sample string 2",
      "Implied": true,
      "Consents": [
        {
          "ConsentType": "sample string 1",
          "ConsentVersion": "sample string 2"
        },
        {
          "ConsentType": "sample string 1",
          "ConsentVersion": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ConsentFilterList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models">
  <ConsentFilters>
    <ConsentFilter>
      <Consents>
        <ConsentFilterVersion>
          <ConsentType>sample string 1</ConsentType>
          <ConsentVersion>sample string 2</ConsentVersion>
        </ConsentFilterVersion>
        <ConsentFilterVersion>
          <ConsentType>sample string 1</ConsentType>
          <ConsentVersion>sample string 2</ConsentVersion>
        </ConsentFilterVersion>
      </Consents>
      <FilterId>sample string 1</FilterId>
      <Implied>true</Implied>
      <TypeName>sample string 2</TypeName>
    </ConsentFilter>
    <ConsentFilter>
      <Consents>
        <ConsentFilterVersion>
          <ConsentType>sample string 1</ConsentType>
          <ConsentVersion>sample string 2</ConsentVersion>
        </ConsentFilterVersion>
        <ConsentFilterVersion>
          <ConsentType>sample string 1</ConsentType>
          <ConsentVersion>sample string 2</ConsentVersion>
        </ConsentFilterVersion>
      </Consents>
      <FilterId>sample string 1</FilterId>
      <Implied>true</Implied>
      <TypeName>sample string 2</TypeName>
    </ConsentFilter>
  </ConsentFilters>
</ConsentFilterList>