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

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

Gets the SmsMessageModels for a given Publication.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
publicationId

Id of the Publication the SmsMessageModels belongs to.

integer

Required

Body Parameters

None.

Response Information

Resource Description

An array of SmsMessageModels.

Collection of SmsMessageModel
NameDescriptionTypeAdditional information
Id

Id of the SmsMessage.

integer

None.

Name

Name of the SmsMessage.

string

None.

CreatedByUserId

Id of the User creating the SmsMessage.

integer

None.

MessageStatus

The MessageStatus of the SmsMessage.

MessageStatus

None.

CreationDate

Date and time when the SmsMessage was created.

date

None.

ModifiedDate

Date and time when the SmsMessage was last modified.

date

None.

PublicationId

Id the of Publication the SmsMessage belongs to.

integer

None.

SenderName

Sender name of the SmsMessage.

string

None.

DefaultCountryCode

Default country code of the SmsMessage. Will be used for all recipients without country code in their mobile number.

integer

None.

SmsContentId

Id of the Content holding the content of the SmsMessage.

integer

None.

ScheduledSendDate

Date and time when the SmsMessage will be sent.

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "CreatedByUserId": 3,
    "MessageStatus": 0,
    "CreationDate": "2024-11-21T17:58:11.0140872+01:00",
    "ModifiedDate": "2024-11-21T17:58:11.0140872+01:00",
    "PublicationId": 6,
    "SenderName": "sample string 7",
    "DefaultCountryCode": 8,
    "SmsContentId": 1,
    "ScheduledSendDate": "2024-11-21T17:58:11.0140872+01:00"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "CreatedByUserId": 3,
    "MessageStatus": 0,
    "CreationDate": "2024-11-21T17:58:11.0140872+01:00",
    "ModifiedDate": "2024-11-21T17:58:11.0140872+01:00",
    "PublicationId": 6,
    "SenderName": "sample string 7",
    "DefaultCountryCode": 8,
    "SmsContentId": 1,
    "ScheduledSendDate": "2024-11-21T17:58:11.0140872+01:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSmsMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsMessage">
  <SmsMessageModel>
    <CreatedByUserId>3</CreatedByUserId>
    <CreationDate>2024-11-21T17:58:11.0140872+01:00</CreationDate>
    <DefaultCountryCode>8</DefaultCountryCode>
    <Id>1</Id>
    <MessageStatus>NotReadyToSend</MessageStatus>
    <ModifiedDate>2024-11-21T17:58:11.0140872+01:00</ModifiedDate>
    <Name>sample string 2</Name>
    <PublicationId>6</PublicationId>
    <ScheduledSendDate>2024-11-21T17:58:11.0140872+01:00</ScheduledSendDate>
    <SenderName>sample string 7</SenderName>
    <SmsContentId>1</SmsContentId>
  </SmsMessageModel>
  <SmsMessageModel>
    <CreatedByUserId>3</CreatedByUserId>
    <CreationDate>2024-11-21T17:58:11.0140872+01:00</CreationDate>
    <DefaultCountryCode>8</DefaultCountryCode>
    <Id>1</Id>
    <MessageStatus>NotReadyToSend</MessageStatus>
    <ModifiedDate>2024-11-21T17:58:11.0140872+01:00</ModifiedDate>
    <Name>sample string 2</Name>
    <PublicationId>6</PublicationId>
    <ScheduledSendDate>2024-11-21T17:58:11.0140872+01:00</ScheduledSendDate>
    <SenderName>sample string 7</SenderName>
    <SmsContentId>1</SmsContentId>
  </SmsMessageModel>
</ArrayOfSmsMessageModel>