GET {clientId}/Config/RequiredPreferenceConsents/{filterId}

Retrieve Required Preference Consents

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.

 string

Required
filterId

The ID of the Filter thats required preference consents will be returned.

 string

Required

Body Parameters

None.

Response Information

Response Codes

  • Unauthorized (401)
  • InternalServerError (500)

Resource Description

ConfigConsentResult
NameDescriptionTypeAdditional information
RequiredPreferenceConsents

Collection of ConfigConsent

None.

Response Formats

application/json, text/json

Sample: 
{
  "RequiredPreferenceConsents": [
    {
      "TypeName": "sample string 2",
      "DisplayOrder": 3
    }
  ]
}

application/xml, text/xml

Sample: 
<ConfigConsentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.ConfigModels">
  <RequiredPreferenceConsents>
    <ConfigConsent>
      <ConsentTypeLink>1</ConsentTypeLink>
      <DisplayOrder>3</DisplayOrder>
      <TypeName>sample string 2</TypeName>
    </ConfigConsent>
  </RequiredPreferenceConsents>
</ConfigConsentResult>