POST example/api/mailstatistics/GetOpeningsByOpeningId

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

Gets openings.

Request Information

URI Parameters

None.

Body Parameters

Max number of openings to get

Name	Description	Type	Additional information
FromOpeningId	Id of the first opening to be returned	integer	Required
BatchSize	Max number of openings to get	integer	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<GetOpeningsByIdArgs 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>
  <FromOpeningId>1</FromOpeningId>
</GetOpeningsByIdArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of MailMessageOpeningModels.

Collection of MailMessageOpeningModel

Name	Description	Type	Additional information
Id	Gets or sets the id.	integer	None.
MailRecipientModel	Gets or sets the MailRecipientModel that opened.	MailRecipientModel	None.
MailMessageQueueId	Gets or sets the id of the MailMessageQueue.	integer	None.
CreationDate	Gets or sets the creation (opening) date and time.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-11-21T17:50:52.0746612+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,
    "CreationDate": "2024-11-21T17:50:52.0746612+01:00"
  },
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-11-21T17:50:52.0746612+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,
    "CreationDate": "2024-11-21T17:50:52.0746612+01:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailMessageOpeningModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailStatistics">
  <MailMessageOpeningModel>
    <CreationDate>2024-11-21T17:50:52.0746612+01:00</CreationDate>
    <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-21T17:50:52.0746612+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>
  </MailMessageOpeningModel>
  <MailMessageOpeningModel>
    <CreationDate>2024-11-21T17:50:52.0746612+01:00</CreationDate>
    <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-21T17:50:52.0746612+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>
  </MailMessageOpeningModel>
</ArrayOfMailMessageOpeningModel>