GET {clientId}/ConsentTypes?Id={Id}&locale={locale}
This method will retrieve all Consent Types defined in your MyPreferences account. Optionally you can include a locale to filter the results by a specific locale. ConsentTypes are unique amongst Types in that all other Types are used as a “preference key” for storing preferences. Consents however, are not associated with a communication channel or an identity. They are simply attached to a user profile
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
This is your organization’s MyPreferences Account Id. |
string |
Required |
Id |
Optional Type Id. If specified, only the Type with this Id will be returned. |
integer |
Default value is 0 |
locale |
A valid locale associated with the ConsentType. Ex: “en”, “en-us”, “en-uk”, “fr-ca”. |
string |
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. |
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
ConsentTypeEntryListName | Description | Type | Additional information |
---|---|---|---|
ConsentTypes |
A collection of Consent Types that can be associated with a Profile. |
Collection of ConsentTypeEntry |
Response Formats
application/json, text/json, application/json-patch+json
{ "ConsentTypes": [ { "TypeId": 1, "Edited": { "CreateDate": "sample string 1", "CreatedBy": "sample string 2", "ModifiedDate": "sample string 3", "ModifiedBy": "sample string 4" }, "Versions": [ { "ConsentVersionId": 1, "Edited": { "CreateDate": "sample string 1", "CreatedBy": "sample string 2", "ModifiedDate": "sample string 3", "ModifiedBy": "sample string 4" }, "ConsentVersion": "sample string 2", "LocalizedFields": [ { "ConsentLanguage": "sample string 1", "Locale": "sample string 2", "Name": "sample string 3", "Description": "sample string 4" }, { "ConsentLanguage": "sample string 1", "Locale": "sample string 2", "Name": "sample string 3", "Description": "sample string 4" } ], "ExpirationInDays": 3, "IsActive": true, "IsAssociatedWithProfiles": true }, { "ConsentVersionId": 1, "Edited": { "CreateDate": "sample string 1", "CreatedBy": "sample string 2", "ModifiedDate": "sample string 3", "ModifiedBy": "sample string 4" }, "ConsentVersion": "sample string 2", "LocalizedFields": [ { "ConsentLanguage": "sample string 1", "Locale": "sample string 2", "Name": "sample string 3", "Description": "sample string 4" }, { "ConsentLanguage": "sample string 1", "Locale": "sample string 2", "Name": "sample string 3", "Description": "sample string 4" } ], "ExpirationInDays": 3, "IsActive": true, "IsAssociatedWithProfiles": true } ], "TypeName": "sample string 2", "IsActive": true }, { "TypeId": 1, "Edited": { "CreateDate": "sample string 1", "CreatedBy": "sample string 2", "ModifiedDate": "sample string 3", "ModifiedBy": "sample string 4" }, "Versions": [ { "ConsentVersionId": 1, "Edited": { "CreateDate": "sample string 1", "CreatedBy": "sample string 2", "ModifiedDate": "sample string 3", "ModifiedBy": "sample string 4" }, "ConsentVersion": "sample string 2", "LocalizedFields": [ { "ConsentLanguage": "sample string 1", "Locale": "sample string 2", "Name": "sample string 3", "Description": "sample string 4" }, { "ConsentLanguage": "sample string 1", "Locale": "sample string 2", "Name": "sample string 3", "Description": "sample string 4" } ], "ExpirationInDays": 3, "IsActive": true, "IsAssociatedWithProfiles": true }, { "ConsentVersionId": 1, "Edited": { "CreateDate": "sample string 1", "CreatedBy": "sample string 2", "ModifiedDate": "sample string 3", "ModifiedBy": "sample string 4" }, "ConsentVersion": "sample string 2", "LocalizedFields": [ { "ConsentLanguage": "sample string 1", "Locale": "sample string 2", "Name": "sample string 3", "Description": "sample string 4" }, { "ConsentLanguage": "sample string 1", "Locale": "sample string 2", "Name": "sample string 3", "Description": "sample string 4" } ], "ExpirationInDays": 3, "IsActive": true, "IsAssociatedWithProfiles": true } ], "TypeName": "sample string 2", "IsActive": true } ] }
application/xml, text/xml
<ConsentTypeEntryList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models"> <ConsentTypes> <ConsentTypeEntry> <IsActive>true</IsActive> <TypeName>sample string 2</TypeName> <Edited> <CreateDate>sample string 1</CreateDate> <CreatedBy>sample string 2</CreatedBy> <ModifiedBy>sample string 4</ModifiedBy> <ModifiedDate>sample string 3</ModifiedDate> </Edited> <TypeId>1</TypeId> <Versions> <ConsentVersion> <ConsentVersion>sample string 2</ConsentVersion> <ExpirationInDays>3</ExpirationInDays> <IsActive>true</IsActive> <IsAssociatedWithProfiles>true</IsAssociatedWithProfiles> <LocalizedFields> <LocalizedConsentField> <Description>sample string 4</Description> <Locale>sample string 2</Locale> <Name>sample string 3</Name> <ConsentLanguage>sample string 1</ConsentLanguage> </LocalizedConsentField> <LocalizedConsentField> <Description>sample string 4</Description> <Locale>sample string 2</Locale> <Name>sample string 3</Name> <ConsentLanguage>sample string 1</ConsentLanguage> </LocalizedConsentField> </LocalizedFields> <ConsentVersionId>1</ConsentVersionId> <Edited> <CreateDate>sample string 1</CreateDate> <CreatedBy>sample string 2</CreatedBy> <ModifiedBy>sample string 4</ModifiedBy> <ModifiedDate>sample string 3</ModifiedDate> </Edited> </ConsentVersion> <ConsentVersion> <ConsentVersion>sample string 2</ConsentVersion> <ExpirationInDays>3</ExpirationInDays> <IsActive>true</IsActive> <IsAssociatedWithProfiles>true</IsAssociatedWithProfiles> <LocalizedFields> <LocalizedConsentField> <Description>sample string 4</Description> <Locale>sample string 2</Locale> <Name>sample string 3</Name> <ConsentLanguage>sample string 1</ConsentLanguage> </LocalizedConsentField> <LocalizedConsentField> <Description>sample string 4</Description> <Locale>sample string 2</Locale> <Name>sample string 3</Name> <ConsentLanguage>sample string 1</ConsentLanguage> </LocalizedConsentField> </LocalizedFields> <ConsentVersionId>1</ConsentVersionId> <Edited> <CreateDate>sample string 1</CreateDate> <CreatedBy>sample string 2</CreatedBy> <ModifiedBy>sample string 4</ModifiedBy> <ModifiedDate>sample string 3</ModifiedDate> </Edited> </ConsentVersion> </Versions> </ConsentTypeEntry> <ConsentTypeEntry> <IsActive>true</IsActive> <TypeName>sample string 2</TypeName> <Edited> <CreateDate>sample string 1</CreateDate> <CreatedBy>sample string 2</CreatedBy> <ModifiedBy>sample string 4</ModifiedBy> <ModifiedDate>sample string 3</ModifiedDate> </Edited> <TypeId>1</TypeId> <Versions> <ConsentVersion> <ConsentVersion>sample string 2</ConsentVersion> <ExpirationInDays>3</ExpirationInDays> <IsActive>true</IsActive> <IsAssociatedWithProfiles>true</IsAssociatedWithProfiles> <LocalizedFields> <LocalizedConsentField> <Description>sample string 4</Description> <Locale>sample string 2</Locale> <Name>sample string 3</Name> <ConsentLanguage>sample string 1</ConsentLanguage> </LocalizedConsentField> <LocalizedConsentField> <Description>sample string 4</Description> <Locale>sample string 2</Locale> <Name>sample string 3</Name> <ConsentLanguage>sample string 1</ConsentLanguage> </LocalizedConsentField> </LocalizedFields> <ConsentVersionId>1</ConsentVersionId> <Edited> <CreateDate>sample string 1</CreateDate> <CreatedBy>sample string 2</CreatedBy> <ModifiedBy>sample string 4</ModifiedBy> <ModifiedDate>sample string 3</ModifiedDate> </Edited> </ConsentVersion> <ConsentVersion> <ConsentVersion>sample string 2</ConsentVersion> <ExpirationInDays>3</ExpirationInDays> <IsActive>true</IsActive> <IsAssociatedWithProfiles>true</IsAssociatedWithProfiles> <LocalizedFields> <LocalizedConsentField> <Description>sample string 4</Description> <Locale>sample string 2</Locale> <Name>sample string 3</Name> <ConsentLanguage>sample string 1</ConsentLanguage> </LocalizedConsentField> <LocalizedConsentField> <Description>sample string 4</Description> <Locale>sample string 2</Locale> <Name>sample string 3</Name> <ConsentLanguage>sample string 1</ConsentLanguage> </LocalizedConsentField> </LocalizedFields> <ConsentVersionId>1</ConsentVersionId> <Edited> <CreateDate>sample string 1</CreateDate> <CreatedBy>sample string 2</CreatedBy> <ModifiedBy>sample string 4</ModifiedBy> <ModifiedDate>sample string 3</ModifiedDate> </Edited> </ConsentVersion> </Versions> </ConsentTypeEntry> </ConsentTypes> </ConsentTypeEntryList>