POST example/api/transactionmailstatistics/GetBouncesByBounceId

https://app.bwz.se/bedrock/example/api/transactionmailstatistics/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:

<GetTransactionMailBouncesByIdArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.TransactionMailStatistics">
  <BatchSize>2</BatchSize>
  <BounceType>HARD_BOUNCE</BounceType>
  <FromBounceId>1</FromBounceId>
</GetTransactionMailBouncesByIdArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of TransactionMailBounceModels.

Collection of TransactionMailBounceModel

Name	Description	Type	Additional information
Id	Gets or sets the id.	integer	None.
TransactionMailModel	Gets or sets the TransactionMailModel that bounced.	TransactionMailModel	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,
    "TransactionMailModel": {
      "TransactionMailId": 1,
      "RecipientName": "sample string 2",
      "RecipientEmail": "sample string 3",
      "SenderName": "sample string 4",
      "SenderEmail": "sample string 5",
      "FromName": "sample string 6",
      "FromEmail": "sample string 7",
      "ReplyTo": "sample string 8",
      "Subject": "sample string 9",
      "TrackOpenings": true,
      "TrackLinkClicks": true,
      "LinkBaseUrl": "sample string 12",
      "ExternalId": "sample string 13",
      "ExcludeTotalOptouts": true,
      "ExcludePublicationOptouts": true,
      "ExcludePreviousBounce": true,
      "IsInternalMail": true,
      "CreationDate": "2024-11-21T17:39:24.6331528+01:00",
      "IncludeEmailDataInWebhookPayload": true
    },
    "BounceType": 1,
    "BounceDescription": "sample string 2",
    "CreationDate": "2024-11-21T17:39:24.6331528+01:00"
  },
  {
    "Id": 1,
    "TransactionMailModel": {
      "TransactionMailId": 1,
      "RecipientName": "sample string 2",
      "RecipientEmail": "sample string 3",
      "SenderName": "sample string 4",
      "SenderEmail": "sample string 5",
      "FromName": "sample string 6",
      "FromEmail": "sample string 7",
      "ReplyTo": "sample string 8",
      "Subject": "sample string 9",
      "TrackOpenings": true,
      "TrackLinkClicks": true,
      "LinkBaseUrl": "sample string 12",
      "ExternalId": "sample string 13",
      "ExcludeTotalOptouts": true,
      "ExcludePublicationOptouts": true,
      "ExcludePreviousBounce": true,
      "IsInternalMail": true,
      "CreationDate": "2024-11-21T17:39:24.6331528+01:00",
      "IncludeEmailDataInWebhookPayload": true
    },
    "BounceType": 1,
    "BounceDescription": "sample string 2",
    "CreationDate": "2024-11-21T17:39:24.6331528+01:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfTransactionMailBounceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.TransactionMailStatistics">
  <TransactionMailBounceModel>
    <BounceDescription>sample string 2</BounceDescription>
    <BounceType>HARD_BOUNCE</BounceType>
    <CreationDate>2024-11-21T17:39:24.6331528+01:00</CreationDate>
    <Id>1</Id>
    <TransactionMailModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.TransactionMail">
      <d3p1:CreationDate>2024-11-21T17:39:24.6331528+01:00</d3p1:CreationDate>
      <d3p1:ExcludePreviousBounce>true</d3p1:ExcludePreviousBounce>
      <d3p1:ExcludePublicationOptouts>true</d3p1:ExcludePublicationOptouts>
      <d3p1:ExcludeTotalOptouts>true</d3p1:ExcludeTotalOptouts>
      <d3p1:ExternalId>sample string 13</d3p1:ExternalId>
      <d3p1:FromEmail>sample string 7</d3p1:FromEmail>
      <d3p1:FromName>sample string 6</d3p1:FromName>
      <d3p1:IncludeEmailDataInWebhookPayload>true</d3p1:IncludeEmailDataInWebhookPayload>
      <d3p1:IsInternalMail>true</d3p1:IsInternalMail>
      <d3p1:LinkBaseUrl>sample string 12</d3p1:LinkBaseUrl>
      <d3p1:RecipientEmail>sample string 3</d3p1:RecipientEmail>
      <d3p1:RecipientName>sample string 2</d3p1:RecipientName>
      <d3p1:ReplyTo>sample string 8</d3p1:ReplyTo>
      <d3p1:SenderEmail>sample string 5</d3p1:SenderEmail>
      <d3p1:SenderName>sample string 4</d3p1:SenderName>
      <d3p1:Subject>sample string 9</d3p1:Subject>
      <d3p1:TrackLinkClicks>true</d3p1:TrackLinkClicks>
      <d3p1:TrackOpenings>true</d3p1:TrackOpenings>
      <d3p1:TransactionMailId>1</d3p1:TransactionMailId>
    </TransactionMailModel>
  </TransactionMailBounceModel>
  <TransactionMailBounceModel>
    <BounceDescription>sample string 2</BounceDescription>
    <BounceType>HARD_BOUNCE</BounceType>
    <CreationDate>2024-11-21T17:39:24.6331528+01:00</CreationDate>
    <Id>1</Id>
    <TransactionMailModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.TransactionMail">
      <d3p1:CreationDate>2024-11-21T17:39:24.6331528+01:00</d3p1:CreationDate>
      <d3p1:ExcludePreviousBounce>true</d3p1:ExcludePreviousBounce>
      <d3p1:ExcludePublicationOptouts>true</d3p1:ExcludePublicationOptouts>
      <d3p1:ExcludeTotalOptouts>true</d3p1:ExcludeTotalOptouts>
      <d3p1:ExternalId>sample string 13</d3p1:ExternalId>
      <d3p1:FromEmail>sample string 7</d3p1:FromEmail>
      <d3p1:FromName>sample string 6</d3p1:FromName>
      <d3p1:IncludeEmailDataInWebhookPayload>true</d3p1:IncludeEmailDataInWebhookPayload>
      <d3p1:IsInternalMail>true</d3p1:IsInternalMail>
      <d3p1:LinkBaseUrl>sample string 12</d3p1:LinkBaseUrl>
      <d3p1:RecipientEmail>sample string 3</d3p1:RecipientEmail>
      <d3p1:RecipientName>sample string 2</d3p1:RecipientName>
      <d3p1:ReplyTo>sample string 8</d3p1:ReplyTo>
      <d3p1:SenderEmail>sample string 5</d3p1:SenderEmail>
      <d3p1:SenderName>sample string 4</d3p1:SenderName>
      <d3p1:Subject>sample string 9</d3p1:Subject>
      <d3p1:TrackLinkClicks>true</d3p1:TrackLinkClicks>
      <d3p1:TrackOpenings>true</d3p1:TrackOpenings>
      <d3p1:TransactionMailId>1</d3p1:TransactionMailId>
    </TransactionMailModel>
  </TransactionMailBounceModel>
</ArrayOfTransactionMailBounceModel>