GET {clientId}/Preferences/Email/{email}/Implied
Retrieve implied and expressed preferences for an email address.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid. |
string |
Required |
|
Retrieve preferencs for specific email address. A 400 is returned if this value is empty. |
string |
Required |
Body Parameters
None.
Response Information
Response Codes
- NotFound (404)
- BadRequest (400)
- Unauthorized (401)
Resource Description
PreferenceResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Preferences | Collection of Preference |
None. |
Response Formats
application/json, text/json
Sample:
{
"Preferences": [
{
"ProgramID": "sample string 1",
"ChannelID": "sample string 2",
"UserID": "sample string 3",
"SourceID": "sample string 4",
"LastModifiedDate": "sample string 5",
"FilterID": "sample string 6",
"CustomProperties": [
{
"Link": 1,
"Key": "sample string 2",
"Value": "sample string 3"
}
],
"CID": "sample string 7",
"Prefix": "sample string 8",
"FirstName": "sample string 9",
"MiddleName": "sample string 10",
"LastName": "sample string 11",
"Suffix": "sample string 12",
"PreferenceType": 13,
"ContactElement": {
"Email": "sample string 1",
"PFT": "sample string 2",
"Address1": "sample string 3",
"Address2": "sample string 4",
"City": "sample string 5",
"StateProvince": "sample string 6",
"CountryCode": "sample string 7",
"PostalCode": "sample string 8"
},
"FrequencyID": "sample string 14",
"PreferenceAttributes": [
{
"Link": 1,
"Key": "sample string 2",
"Value": "sample string 3"
}
],
"CustomerDate": "sample string 15",
"MatchType": "sample string 16",
"ReasonCode": "sample string 17",
"ExpirationDate": "sample string 18",
"PreferenceStatus": "sample string 19"
}
]
}
application/xml, text/xml
Sample:
<PreferenceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Codebase.Results">
<Preferences xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
<d2p1:Preference>
<d2p1:CID>sample string 7</d2p1:CID>
<d2p1:ChannelID>sample string 2</d2p1:ChannelID>
<d2p1:ContactElement>
<d2p1:Address1>sample string 3</d2p1:Address1>
<d2p1:Address2>sample string 4</d2p1:Address2>
<d2p1:City>sample string 5</d2p1:City>
<d2p1:CountryCode>sample string 7</d2p1:CountryCode>
<d2p1:Email>sample string 1</d2p1:Email>
<d2p1:PFT>sample string 2</d2p1:PFT>
<d2p1:PostalCode>sample string 8</d2p1:PostalCode>
<d2p1:StateProvince>sample string 6</d2p1:StateProvince>
</d2p1:ContactElement>
<d2p1:CustomProperties>
<d2p1:Attribute>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Link>1</d2p1:Link>
<d2p1:Value>sample string 3</d2p1:Value>
</d2p1:Attribute>
</d2p1:CustomProperties>
<d2p1:CustomerDate>sample string 15</d2p1:CustomerDate>
<d2p1:ExpirationDate>sample string 18</d2p1:ExpirationDate>
<d2p1:FilterID>sample string 6</d2p1:FilterID>
<d2p1:FirstName>sample string 9</d2p1:FirstName>
<d2p1:FrequencyID>sample string 14</d2p1:FrequencyID>
<d2p1:LastModifiedDate>sample string 5</d2p1:LastModifiedDate>
<d2p1:LastName>sample string 11</d2p1:LastName>
<d2p1:MatchType>sample string 16</d2p1:MatchType>
<d2p1:MiddleName>sample string 10</d2p1:MiddleName>
<d2p1:PrefXML>sample string 26</d2p1:PrefXML>
<d2p1:PreferenceAttributes>
<d2p1:Attribute>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Link>1</d2p1:Link>
<d2p1:Value>sample string 3</d2p1:Value>
</d2p1:Attribute>
</d2p1:PreferenceAttributes>
<d2p1:PreferenceStatus>sample string 19</d2p1:PreferenceStatus>
<d2p1:PreferenceType>13</d2p1:PreferenceType>
<d2p1:Prefix>sample string 8</d2p1:Prefix>
<d2p1:ProgramID>sample string 1</d2p1:ProgramID>
<d2p1:ReasonCode>sample string 17</d2p1:ReasonCode>
<d2p1:SourceID>sample string 4</d2p1:SourceID>
<d2p1:Suffix>sample string 12</d2p1:Suffix>
<d2p1:UserID>sample string 3</d2p1:UserID>
</d2p1:Preference>
</Preferences>
</PreferenceResult>