GET {clientId}/ConsentStatus

This method will retrieve Consent Statuses supported by MyPreferences

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

This is your organization’s MyPreferences Account Id.

string

Required

Body Parameters

None.

Response Information

Response Codes

HTTP Status CodeTextDescription
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.
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

ConsentStatusList
NameDescriptionTypeAdditional information
ConsentStatus

A collection of Consent Statuses that can be associated with a Profile. Supported consent statuses are 1: Granted, 2: Denied, 3: Revoked, 4: NotSet.

Collection of ConsentStatus

Response Formats

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

Sample:
{
  "ConsentStatus": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<ConsentStatusList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models">
  <ConsentStatus>
    <ConsentStatus>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </ConsentStatus>
    <ConsentStatus>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </ConsentStatus>
  </ConsentStatus>
</ConsentStatusList>