GET example/api/mailrecipient/GetAll?Page={Page}&PageSize={PageSize}

https://app.bwz.se/bedrock/example/api/mailrecipient/GetAll?Page={Page}&PageSize={PageSize}

Gets all recipients paginated.

Request Information

URI Parameters

None.

Body Parameters

Max number of recipients to get.

GetAllRecipientsArgs
NameDescriptionTypeAdditional information
Page

Id of the first bounce to be returned.

integer

Required

PageSize

Max number of recipients to get.

integer

Required

Response Information

Resource Description

An array of MailRecipientModels.

Collection of MailRecipientModel
NameDescriptionTypeAdditional information
CreatedByUserId

Id of the user which created the recipient

integer

None.

CreationDate

Gets or sets the creation date.

date

None.

Email

Gets or sets the email.

string

None.

Id

Gets or sets the identifier.

integer

None.

RecipientEntrySource

Gets or sets the recipient entry source.

string

None.

Properties

Gets or sets the properties.

Collection of PropertyValueModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CreatedByUserId": 1,
    "CreationDate": "2024-12-23T06:09:51.9705657+01:00",
    "Email": "sample string 3",
    "Id": 4,
    "RecipientEntrySource": "sample string 5",
    "Properties": [
      {
        "Name": "sample string 1",
        "Value": {}
      },
      {
        "Name": "sample string 1",
        "Value": {}
      }
    ]
  },
  {
    "CreatedByUserId": 1,
    "CreationDate": "2024-12-23T06:09:51.9705657+01:00",
    "Email": "sample string 3",
    "Id": 4,
    "RecipientEntrySource": "sample string 5",
    "Properties": [
      {
        "Name": "sample string 1",
        "Value": {}
      },
      {
        "Name": "sample string 1",
        "Value": {}
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfMailRecipientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipient">
  <MailRecipientModel>
    <CreatedByUserId>1</CreatedByUserId>
    <CreationDate>2024-12-23T06:09:51.9705657+01:00</CreationDate>
    <Email>sample string 3</Email>
    <Id>4</Id>
    <Properties>
      <PropertyValueModel>
        <Name>sample string 1</Name>
        <Value />
      </PropertyValueModel>
      <PropertyValueModel>
        <Name>sample string 1</Name>
        <Value />
      </PropertyValueModel>
    </Properties>
    <RecipientEntrySource>sample string 5</RecipientEntrySource>
  </MailRecipientModel>
  <MailRecipientModel>
    <CreatedByUserId>1</CreatedByUserId>
    <CreationDate>2024-12-23T06:09:51.9705657+01:00</CreationDate>
    <Email>sample string 3</Email>
    <Id>4</Id>
    <Properties>
      <PropertyValueModel>
        <Name>sample string 1</Name>
        <Value />
      </PropertyValueModel>
      <PropertyValueModel>
        <Name>sample string 1</Name>
        <Value />
      </PropertyValueModel>
    </Properties>
    <RecipientEntrySource>sample string 5</RecipientEntrySource>
  </MailRecipientModel>
</ArrayOfMailRecipientModel>