PUT example/api/SmsRecipientList/Clear/{id}

https://app.bwz.se/bedrock/example/api/SmsRecipientList/Clear/{id}

Clears a SmsRecipientList and returns the empty list.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the SmsRecipientList to be cleared.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The cleared SmsRecipientList

SmsRecipientListModel

Name	Description	Type	Additional 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-23T07:04:32.55585+01:00",
  "ListType": 1,
  "CreatedByUserId": 5,
  "RecipientCount": 6,
  "LastRecipientAdded": "2024-12-23T07:04:32.55585+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-23T07:04:32.55585+01:00</CreationDate>
  <Description>sample string 3</Description>
  <Id>1</Id>
  <LastRecipientAdded>2024-12-23T07:04:32.55585+01:00</LastRecipientAdded>
  <ListType>REGULAR</ListType>
  <Name>sample string 2</Name>
  <RecipientCount>6</RecipientCount>
</SmsRecipientListModel>