POST example/api/mailstatistics/GetOptOutsByOptOutId

https://app.bwz.se/bedrock/example/api/mailstatistics/GetOptOutsByOptOutId

Gets Opt-outs.

Request Information

URI Parameters

None.

Body Parameters

Max number of Opt-outs to get.

Name	Description	Type	Additional information
FromOptOutId	Id of the first Opt-out to be returned.	integer	Required
BatchSize	Max number of Opt-outs to get.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FromOptOutId": 1,
  "BatchSize": 2
}

application/xml, text/xml

Sample:

<GetOptOutsByIdArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailStatistics">
  <BatchSize>2</BatchSize>
  <FromOptOutId>1</FromOptOutId>
</GetOptOutsByIdArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of MailMessageOptOutModels.

Collection of MailMessageOptOutModel

Name	Description	Type	Additional information
Id	Gets or sets the id.	integer	None.
MailRecipientModel	Gets or sets the MailRecipientModel that opted out.	MailRecipientModel	None.
MailMessageQueueId	Gets or sets the id of the MailMessageQueue.	integer	None.
OptOutDate	Gets or sets the Opt-out date and time.	date	None.
PublicationId	Gets or sets the Publication the MailRecipient opted out from.	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-11-24T01:22:26.1849099+01:00",
      "Email": "sample string 3",
      "Id": 4,
      "RecipientEntrySource": "sample string 5",
      "Properties": [
        {
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    },
    "MailMessageQueueId": 2,
    "OptOutDate": "2024-11-24T01:22:26.1849099+01:00",
    "PublicationId": 4
  },
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-11-24T01:22:26.1849099+01:00",
      "Email": "sample string 3",
      "Id": 4,
      "RecipientEntrySource": "sample string 5",
      "Properties": [
        {
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    },
    "MailMessageQueueId": 2,
    "OptOutDate": "2024-11-24T01:22:26.1849099+01:00",
    "PublicationId": 4
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailMessageOptOutModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailStatistics">
  <MailMessageOptOutModel>
    <Id>1</Id>
    <MailMessageQueueId>2</MailMessageQueueId>
    <MailRecipientModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipient">
      <d3p1:CreatedByUserId>1</d3p1:CreatedByUserId>
      <d3p1:CreationDate>2024-11-24T01:22:26.1849099+01:00</d3p1:CreationDate>
      <d3p1:Email>sample string 3</d3p1:Email>
      <d3p1:Id>4</d3p1:Id>
      <d3p1:Properties>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
      </d3p1:Properties>
      <d3p1:RecipientEntrySource>sample string 5</d3p1:RecipientEntrySource>
    </MailRecipientModel>
    <OptOutDate>2024-11-24T01:22:26.1849099+01:00</OptOutDate>
    <PublicationId>4</PublicationId>
  </MailMessageOptOutModel>
  <MailMessageOptOutModel>
    <Id>1</Id>
    <MailMessageQueueId>2</MailMessageQueueId>
    <MailRecipientModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipient">
      <d3p1:CreatedByUserId>1</d3p1:CreatedByUserId>
      <d3p1:CreationDate>2024-11-24T01:22:26.1849099+01:00</d3p1:CreationDate>
      <d3p1:Email>sample string 3</d3p1:Email>
      <d3p1:Id>4</d3p1:Id>
      <d3p1:Properties>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
      </d3p1:Properties>
      <d3p1:RecipientEntrySource>sample string 5</d3p1:RecipientEntrySource>
    </MailRecipientModel>
    <OptOutDate>2024-11-24T01:22:26.1849099+01:00</OptOutDate>
    <PublicationId>4</PublicationId>
  </MailMessageOptOutModel>
</ArrayOfMailMessageOptOutModel>