POST {version}/Subscribe

Subscribe emails contained in the JSON list which must be 20 items or less.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

A JSON object that contains one or more combination of Email and Source ID

Collection of Aristotle.P6.ViewModels.Entity.EmailSubscription
NameDescriptionTypeAdditional information
SourceId

string

None.

Email

string

None.

ResponseStatus

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "SourceId": "sample string 1",
    "Email": "sample string 2",
    "ResponseStatus": "sample string 3"
  },
  {
    "SourceId": "sample string 1",
    "Email": "sample string 2",
    "ResponseStatus": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEmailSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aristotle.P6.ViewModels.Entity">
  <EmailSubscription>
    <Email>sample string 2</Email>
    <ResponseStatus>sample string 3</ResponseStatus>
    <SourceId>sample string 1</SourceId>
  </EmailSubscription>
  <EmailSubscription>
    <Email>sample string 2</Email>
    <ResponseStatus>sample string 3</ResponseStatus>
    <SourceId>sample string 1</SourceId>
  </EmailSubscription>
</ArrayOfEmailSubscription>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns back the same list of items with Success or Failed messages for each of them. If there's any exception during the execution, there won't record being inserted, and it will return a generic 501 error.

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.