GET example/api/publication/{publicationId}/mailmessages

https://app.bwz.se/bedrock/example/api/publication/{publicationId}/mailmessages

Gets the MailMessageModels for a given Publication.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
publicationId

Id of the Publication the MailMessageModels belongs to.

integer

Required

Body Parameters

None.

Response Information

Resource Description

An array of MailMessageModels.

Collection of MailMessageModel
NameDescriptionTypeAdditional information
Id

Id of the MailMessage.

integer

None.

Name

Name of the MailMessage.

string

None.

CreatedByUserId

Id of the User creating the MailMessage.

integer

None.

MessageStatus

The MessageStatus of the MailMessage.

MessageStatus

None.

CreationDate

Date and time when the MailMessage was created.

date

None.

ModifiedDate

Date and time when the MailMessage was last modified.

date

None.

PublicationId

Id the of Publication the MailMessage belongs to.

integer

None.

Description

Description of the MailMessage.

string

None.

SenderName

Sender name of the MailMessage.

string

None.

SenderEmail

Email address of the sender of the MailMessage.

string

None.

ReplyTo

Reply-to address of the MailMessage.

string

None.

Subject

Subject of the MailMessage.

string

None.

UseStatistics

A flag indicating if the MailMessage will gather statistics when sent.

boolean

None.

HtmlContentId

Id of the Content holding the HTML content of the MailMessage.

integer

None.

TextContentId

Id of the Content holding the text content of the MailMessage.

integer

None.

ScheduledSendDate

Date and time when the MailMessage will be sent.

date

None.

MailTemplateId

Id of the MailTemplate used for the MailMessage

integer

None.

Preheader

Preheader text of the MailMessage

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "CreatedByUserId": 3,
    "MessageStatus": 0,
    "CreationDate": "2024-12-23T06:20:04.8909212+01:00",
    "ModifiedDate": "2024-12-23T06:20:04.8909212+01:00",
    "PublicationId": 6,
    "Description": "sample string 7",
    "SenderName": "sample string 8",
    "SenderEmail": "sample string 9",
    "ReplyTo": "sample string 10",
    "Subject": "sample string 11",
    "UseStatistics": true,
    "HtmlContentId": 1,
    "TextContentId": 1,
    "ScheduledSendDate": "2024-12-23T06:20:04.8909212+01:00",
    "MailTemplateId": 1,
    "Preheader": "sample string 13"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "CreatedByUserId": 3,
    "MessageStatus": 0,
    "CreationDate": "2024-12-23T06:20:04.8909212+01:00",
    "ModifiedDate": "2024-12-23T06:20:04.8909212+01:00",
    "PublicationId": 6,
    "Description": "sample string 7",
    "SenderName": "sample string 8",
    "SenderEmail": "sample string 9",
    "ReplyTo": "sample string 10",
    "Subject": "sample string 11",
    "UseStatistics": true,
    "HtmlContentId": 1,
    "TextContentId": 1,
    "ScheduledSendDate": "2024-12-23T06:20:04.8909212+01:00",
    "MailTemplateId": 1,
    "Preheader": "sample string 13"
  }
]

application/xml, text/xml

Sample:
<ArrayOfMailMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailMessage">
  <MailMessageModel>
    <CreatedByUserId>3</CreatedByUserId>
    <CreationDate>2024-12-23T06:20:04.8909212+01:00</CreationDate>
    <Description>sample string 7</Description>
    <HtmlContentId>1</HtmlContentId>
    <Id>1</Id>
    <MailTemplateId>1</MailTemplateId>
    <MessageStatus>NotReadyToSend</MessageStatus>
    <ModifiedDate>2024-12-23T06:20:04.8909212+01:00</ModifiedDate>
    <Name>sample string 2</Name>
    <Preheader>sample string 13</Preheader>
    <PublicationId>6</PublicationId>
    <ReplyTo>sample string 10</ReplyTo>
    <ScheduledSendDate>2024-12-23T06:20:04.8909212+01:00</ScheduledSendDate>
    <SenderEmail>sample string 9</SenderEmail>
    <SenderName>sample string 8</SenderName>
    <Subject>sample string 11</Subject>
    <TextContentId>1</TextContentId>
    <UseStatistics>true</UseStatistics>
  </MailMessageModel>
  <MailMessageModel>
    <CreatedByUserId>3</CreatedByUserId>
    <CreationDate>2024-12-23T06:20:04.8909212+01:00</CreationDate>
    <Description>sample string 7</Description>
    <HtmlContentId>1</HtmlContentId>
    <Id>1</Id>
    <MailTemplateId>1</MailTemplateId>
    <MessageStatus>NotReadyToSend</MessageStatus>
    <ModifiedDate>2024-12-23T06:20:04.8909212+01:00</ModifiedDate>
    <Name>sample string 2</Name>
    <Preheader>sample string 13</Preheader>
    <PublicationId>6</PublicationId>
    <ReplyTo>sample string 10</ReplyTo>
    <ScheduledSendDate>2024-12-23T06:20:04.8909212+01:00</ScheduledSendDate>
    <SenderEmail>sample string 9</SenderEmail>
    <SenderName>sample string 8</SenderName>
    <Subject>sample string 11</Subject>
    <TextContentId>1</TextContentId>
    <UseStatistics>true</UseStatistics>
  </MailMessageModel>
</ArrayOfMailMessageModel>