GET example/api/mailmessage/{mailMessageId}/mailrecipientlists/included

https://app.bwz.se/bedrock/example/api/mailmessage/{mailMessageId}/mailrecipientlists/included

Gets the MailRecipientLists that will be included for a MailMessage

Request Information

URI Parameters

Name	Description	Type	Additional information
mailMessageId	Id of the MailMessage	integer	Required

Body Parameters

None.

Response Information

Resource Description

Array of MailRecipientLists

Collection of MailRecipientListModel

Name	Description	Type	Additional information
Id	Id of the MailRecipientList.	integer	None.
Name	Name of the MailRecipientList.	string	None.
Description	Description of the MailRecipientList.	string	None.
CreationDate	Date and time when the MailRecipientList was created.	date	None.
ListType	ListType of the MailRecipientList.	RecipientListType	None.
CreatedByUserId	Id of the User who created the MailRecipientList.	integer	None.
RecipientCount	Number of recipients in the MailRecipientList.	integer	None.
LastRecipientAdded	Date and time when last User was added to the MailRecipientList.	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "CreationDate": "2024-11-21T17:56:46.4042216+01:00",
    "ListType": 1,
    "CreatedByUserId": 5,
    "RecipientCount": 6,
    "LastRecipientAdded": "2024-11-21T17:56:46.4042216+01:00"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "CreationDate": "2024-11-21T17:56:46.4042216+01:00",
    "ListType": 1,
    "CreatedByUserId": 5,
    "RecipientCount": 6,
    "LastRecipientAdded": "2024-11-21T17:56:46.4042216+01:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailRecipientListModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipientList">
  <MailRecipientListModel>
    <CreatedByUserId>5</CreatedByUserId>
    <CreationDate>2024-11-21T17:56:46.4042216+01:00</CreationDate>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <LastRecipientAdded>2024-11-21T17:56:46.4042216+01:00</LastRecipientAdded>
    <ListType>REGULAR</ListType>
    <Name>sample string 2</Name>
    <RecipientCount>6</RecipientCount>
  </MailRecipientListModel>
  <MailRecipientListModel>
    <CreatedByUserId>5</CreatedByUserId>
    <CreationDate>2024-11-21T17:56:46.4042216+01:00</CreationDate>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <LastRecipientAdded>2024-11-21T17:56:46.4042216+01:00</LastRecipientAdded>
    <ListType>REGULAR</ListType>
    <Name>sample string 2</Name>
    <RecipientCount>6</RecipientCount>
  </MailRecipientListModel>
</ArrayOfMailRecipientListModel>