POST example/api/SmsRecipientList

https://app.bwz.se/bedrock/example/api/SmsRecipientList

Creates a SmsRecipientList.

Request Information

URI Parameters

None.

Body Parameters

Sets the name.

CreateSmsRecipientListArgs
NameDescriptionTypeAdditional information
Name

Sets the name.

string

Required

Valid name with max 256 characters

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1"
}

application/xml, text/xml

Sample:
<CreateSmsRecipientListArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsRecipientList">
  <Name>sample string 1</Name>
</CreateSmsRecipientListArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The SmsRecipientListModel that has been created.

SmsRecipientListModel
NameDescriptionTypeAdditional information
Id

Id of the SmsRecipientList.

integer

None.

Name

Name of the SmsRecipientList.

string

None.

Description

Description of the SmsRecipientList.

string

None.

CreationDate

Date and time when the SmsRecipientList was created.

date

None.

ListType

ListType of the SmsRecipientList.

RecipientListType

None.

CreatedByUserId

Id of the User who created the SmsRecipientList.

integer

None.

RecipientCount

Number of recipients in the SmsRecipientList.

integer

None.

LastRecipientAdded

Date and time when last User was added to the SmsRecipientList.

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "CreationDate": "2024-12-23T06:11:45.2196341+01:00",
  "ListType": 1,
  "CreatedByUserId": 5,
  "RecipientCount": 6,
  "LastRecipientAdded": "2024-12-23T06:11:45.2196341+01:00"
}

application/xml, text/xml

Sample:
<SmsRecipientListModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.SmsRecipientList">
  <CreatedByUserId>5</CreatedByUserId>
  <CreationDate>2024-12-23T06:11:45.2196341+01:00</CreationDate>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <LastRecipientAdded>2024-12-23T06:11:45.2196341+01:00</LastRecipientAdded>
  <ListType>REGULAR</ListType>
  <Name>sample string 2</Name>
  <RecipientCount>6</RecipientCount>
</SmsRecipientListModel>