GET api/Subscriptions/{id}?emailAddress={emailAddress}

Gets a list of subscriptions for the specified contact.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the user in CRM (Guid)

globally unique identifier

Required

emailAddress

The user's email address. Must match the account associated with the Guid.

string

None.

Body Parameters

None.

Response Information

Resource Description

A single UWEOSubscription object. The "subscriptions" property of the object contains the list of all current subcriptions.

UWEOSubscription
NameDescriptionTypeAdditional information
ContactId

globally unique identifier

None.

EmailAddress

string

None.

Subscriptions

Collection of SingleSubscription

None.

CrmContactId

globally unique identifier

None.

CrmEntityType

string

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "ContactId": "c57898d3-cb4e-44ce-bc84-725666641262",
  "EmailAddress": "sample string 1",
  "Subscriptions": [
    {
      "ObjectId": "a97fa8c7-a6df-4a1a-904a-7e379d605596",
      "ObjectType": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "ObjectId": "a97fa8c7-a6df-4a1a-904a-7e379d605596",
      "ObjectType": "sample string 1",
      "Name": "sample string 2"
    }
  ],
  "CrmContactId": "496cabb0-c54b-4a03-bae3-bf8636902cea",
  "CrmEntityType": "sample string 2"
}

application/xml, text/xml

Sample:
<UWEOSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UWEO.CRM.API.Base.Models">
  <CrmContactId>496cabb0-c54b-4a03-bae3-bf8636902cea</CrmContactId>
  <CrmEntityType>sample string 2</CrmEntityType>
  <ContactId>c57898d3-cb4e-44ce-bc84-725666641262</ContactId>
  <EmailAddress>sample string 1</EmailAddress>
  <Subscriptions>
    <SingleSubscription>
      <Name>sample string 2</Name>
      <ObjectId>a97fa8c7-a6df-4a1a-904a-7e379d605596</ObjectId>
      <ObjectType>sample string 1</ObjectType>
    </SingleSubscription>
    <SingleSubscription>
      <Name>sample string 2</Name>
      <ObjectId>a97fa8c7-a6df-4a1a-904a-7e379d605596</ObjectId>
      <ObjectType>sample string 1</ObjectType>
    </SingleSubscription>
  </Subscriptions>
</UWEOSubscription>