GET api/Member/GetMemberPreferenceDetails?MemberID={MemberID}&CompanyCode={CompanyCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
MemberID

string

None.

CompanyCode

string

None.

Body Parameters

None.

Request Formats

text/json, application/json

Sample:
Request sample for request 

--------------------------------------------------------------------------------------------------------------------------------

{
  "MemberID": "sample string 1",
  "CompanyCode": "sample string 2"
}

--------------------------------------------------------------------------------------------------------------------------------


text/xml, application/xml

Sample:
Request sample for request 

--------------------------------------------------------------------------------------------------------------------------------

<GetMemberPreferenceRequestDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CompanyCode>sample string 2</CompanyCode>
  <MemberID>sample string 1</MemberID>
</GetMemberPreferenceRequestDTO>

--------------------------------------------------------------------------------------------------------------------------------


Response Information

Resource Description

IHttpActionResult

None.

Response Formats

text/json, application/json

Sample:

--------------------------------------------------------------------------------------------------------------------------------

[
  {
    "MemberID": "sample string 1",
    "CompanyCode": "sample string 2",
    "CommunicationPreferences": [
      {
        "CampaignCategoryID": 1,
        "CampaignCategory": "sample string 2",
        "CampaignID": 3,
        "CampaignName": "sample string 4",
        "CommunicationTypeID": 5,
        "CommunicationType": "sample string 6",
        "OptOut": 7,
        "CanOptOut": 8
      },
      {
        "CampaignCategoryID": 1,
        "CampaignCategory": "sample string 2",
        "CampaignID": 3,
        "CampaignName": "sample string 4",
        "CommunicationTypeID": 5,
        "CommunicationType": "sample string 6",
        "OptOut": 7,
        "CanOptOut": 8
      }
    ]
  },
  {
    "MemberID": "sample string 1",
    "CompanyCode": "sample string 2",
    "CommunicationPreferences": [
      {
        "CampaignCategoryID": 1,
        "CampaignCategory": "sample string 2",
        "CampaignID": 3,
        "CampaignName": "sample string 4",
        "CommunicationTypeID": 5,
        "CommunicationType": "sample string 6",
        "OptOut": 7,
        "CanOptOut": 8
      },
      {
        "CampaignCategoryID": 1,
        "CampaignCategory": "sample string 2",
        "CampaignID": 3,
        "CampaignName": "sample string 4",
        "CommunicationTypeID": 5,
        "CommunicationType": "sample string 6",
        "OptOut": 7,
        "CanOptOut": 8
      }
    ]
  }
]

--------------------------------------------------------------------------------------------------------------------------------


text/xml, application/xml

Sample:

--------------------------------------------------------------------------------------------------------------------------------

<ArrayOfGetMemberPreferenceResponseDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <GetMemberPreferenceResponseDTO>
    <CommunicationPreferences>
      <CommunicationDTO>
        <CampaignCategory>sample string 2</CampaignCategory>
        <CampaignCategoryID>1</CampaignCategoryID>
        <CampaignID>3</CampaignID>
        <CampaignName>sample string 4</CampaignName>
        <CanOptOut>8</CanOptOut>
        <CommunicationType>sample string 6</CommunicationType>
        <CommunicationTypeID>5</CommunicationTypeID>
        <OptOut>7</OptOut>
      </CommunicationDTO>
      <CommunicationDTO>
        <CampaignCategory>sample string 2</CampaignCategory>
        <CampaignCategoryID>1</CampaignCategoryID>
        <CampaignID>3</CampaignID>
        <CampaignName>sample string 4</CampaignName>
        <CanOptOut>8</CanOptOut>
        <CommunicationType>sample string 6</CommunicationType>
        <CommunicationTypeID>5</CommunicationTypeID>
        <OptOut>7</OptOut>
      </CommunicationDTO>
    </CommunicationPreferences>
    <CompanyCode>sample string 2</CompanyCode>
    <MemberID>sample string 1</MemberID>
  </GetMemberPreferenceResponseDTO>
  <GetMemberPreferenceResponseDTO>
    <CommunicationPreferences>
      <CommunicationDTO>
        <CampaignCategory>sample string 2</CampaignCategory>
        <CampaignCategoryID>1</CampaignCategoryID>
        <CampaignID>3</CampaignID>
        <CampaignName>sample string 4</CampaignName>
        <CanOptOut>8</CanOptOut>
        <CommunicationType>sample string 6</CommunicationType>
        <CommunicationTypeID>5</CommunicationTypeID>
        <OptOut>7</OptOut>
      </CommunicationDTO>
      <CommunicationDTO>
        <CampaignCategory>sample string 2</CampaignCategory>
        <CampaignCategoryID>1</CampaignCategoryID>
        <CampaignID>3</CampaignID>
        <CampaignName>sample string 4</CampaignName>
        <CanOptOut>8</CanOptOut>
        <CommunicationType>sample string 6</CommunicationType>
        <CommunicationTypeID>5</CommunicationTypeID>
        <OptOut>7</OptOut>
      </CommunicationDTO>
    </CommunicationPreferences>
    <CompanyCode>sample string 2</CompanyCode>
    <MemberID>sample string 1</MemberID>
  </GetMemberPreferenceResponseDTO>
</ArrayOfGetMemberPreferenceResponseDTO>

--------------------------------------------------------------------------------------------------------------------------------