POST example/api/mailstatistics/GetBouncesByBounceId

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

Gets bounces.

Request Information

URI Parameters

None.

Body Parameters

Max number of bounces to get.

Name	Description	Type	Additional information
FromBounceId	Id of the first bounce to be returned.	integer	Required
BounceType	Type of bounce, set to NULL to get bounces of all types.	BounceType	None.
BatchSize	Max number of bounces to get.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FromBounceId": 1,
  "BounceType": 1,
  "BatchSize": 2
}

application/xml, text/xml

Sample:

<GetBouncesByIdArgs 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>
  <BounceType>HARD_BOUNCE</BounceType>
  <FromBounceId>1</FromBounceId>
</GetBouncesByIdArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of MailMessageBounceModels.

Collection of MailMessageBounceModel

Name	Description	Type	Additional information
Id	Gets or sets the id.	integer	None.
MailRecipientModel	Gets or sets the MailRecipientModel that bounced.	MailRecipientModel	None.
MailMessageQueueId	Gets or sets the id of the MailMessageQueue.	integer	None.
EmailAddress	Gets or sets the e-mail address of the MailRecipient that bounced.	string	None.
BounceType	Gets or sets the BounceType.	BounceType	None.
BounceDescription	Gets or sets the description from the server that declared the bounce.	string	None.
CreationDate	Gets or sets the creation date.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-11-24T03:06:16.3217855+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,
    "EmailAddress": "sample string 3",
    "BounceType": 1,
    "BounceDescription": "sample string 4",
    "CreationDate": "2024-11-24T03:06:16.3217855+01:00"
  },
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-11-24T03:06:16.3217855+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,
    "EmailAddress": "sample string 3",
    "BounceType": 1,
    "BounceDescription": "sample string 4",
    "CreationDate": "2024-11-24T03:06:16.3217855+01:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailMessageBounceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailStatistics">
  <MailMessageBounceModel>
    <BounceDescription>sample string 4</BounceDescription>
    <BounceType>HARD_BOUNCE</BounceType>
    <CreationDate>2024-11-24T03:06:16.3217855+01:00</CreationDate>
    <EmailAddress>sample string 3</EmailAddress>
    <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-24T03:06:16.3217855+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>
  </MailMessageBounceModel>
  <MailMessageBounceModel>
    <BounceDescription>sample string 4</BounceDescription>
    <BounceType>HARD_BOUNCE</BounceType>
    <CreationDate>2024-11-24T03:06:16.3217855+01:00</CreationDate>
    <EmailAddress>sample string 3</EmailAddress>
    <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-24T03:06:16.3217855+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>
  </MailMessageBounceModel>
</ArrayOfMailMessageBounceModel>