PUT api/playlist/{id}

Update a playlist along with its relations

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

Playlist

Name	Type	Additional information
ID	integer	None.
Name	string	Required String length: inclusive between 0 and 64
StartDate	date	Data type: Date
StartTime	integer	None.
EndDate	date	Data type: Date
EndTime	integer	None.
Recurrence	integer	None.
RecurrenceType	CampaignScheduleType	None.
MonthType	CampaignMonthlyType	None.
WeekDays	CampaignDayOfWeek	None.
Months	CampaignMonth	None.
MonthWeeks	CampaignWeekOfMonth	None.
MonthDays	string	String length: inclusive between 0 and 32
Active	boolean	None.
Deleted	boolean	None.
LastUpdated	date	Data type: Date
UpdatedByUser	string	String length: inclusive between 0 and 255
CreatedByUser	string	String length: inclusive between 0 and 255
Priority	integer	None.
PlaylistDetails	Collection of PlaylistDetail	None.
PlaylistGroups	Collection of PlaylistGroup	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "name": "sample string 2",
  "startDate": "2025-06-14T06:31:38.5310262",
  "startTime": 1,
  "endDate": "2025-06-14T06:31:38.5310262",
  "endTime": 1,
  "recurrence": 1,
  "recurrenceType": 1,
  "monthType": 1,
  "weekDays": 1,
  "months": 1,
  "monthWeeks": 1,
  "monthDays": "sample string 3",
  "active": true,
  "deleted": true,
  "lastUpdated": "2025-06-14T06:31:38.5310262",
  "updatedByUser": "sample string 4",
  "createdByUser": "sample string 5",
  "priority": 6,
  "playlistDetails": [
    {
      "$id": "2",
      "id": 1,
      "sortOrder": 2,
      "playlistID": 3,
      "advertID": 4,
      "duration": 5,
      "deleted": true,
      "advert": {
        "$id": "3",
        "id": 1,
        "fileName": "sample string 2",
        "extension": "sample string 3",
        "fileSize": 4,
        "isVideo": true,
        "deleted": true,
        "created": "2025-06-14T06:31:38.5310262",
        "updated": "2025-06-14T06:31:38.5310262",
        "imageData": "QEA=",
        "length": 7
      }
    },
    {
      "$ref": "2"
    }
  ],
  "playlistGroups": [
    {
      "$id": "4",
      "id": 1,
      "playlistID": 2,
      "storeID": 3,
      "zoneID": 4
    },
    {
      "$ref": "4"
    }
  ]
}

application/xml, text/xml

Sample:

<Playlist xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Adverts">
  <Active>true</Active>
  <CreatedByUser>sample string 5</CreatedByUser>
  <Deleted>true</Deleted>
  <EndDate>2025-06-14T06:31:38.5310262+00:00</EndDate>
  <EndTime>1</EndTime>
  <ID>1</ID>
  <LastUpdated>2025-06-14T06:31:38.5310262+00:00</LastUpdated>
  <MonthDays>sample string 3</MonthDays>
  <MonthType>1</MonthType>
  <MonthWeeks>1</MonthWeeks>
  <Months>1</Months>
  <Name>sample string 2</Name>
  <PlaylistDetails>
    <PlaylistDetail>
      <Advert>
        <Created>2025-06-14T06:31:38.5310262+00:00</Created>
        <Deleted>true</Deleted>
        <Extension>sample string 3</Extension>
        <FileName>sample string 2</FileName>
        <FileSize>4</FileSize>
        <ID>1</ID>
        <ImageData>QEA=</ImageData>
        <IsVideo>true</IsVideo>
        <Length>7</Length>
        <Updated>2025-06-14T06:31:38.5310262+00:00</Updated>
      </Advert>
      <AdvertID>4</AdvertID>
      <Deleted>true</Deleted>
      <Duration>5</Duration>
      <ID>1</ID>
      <PlaylistID>3</PlaylistID>
      <SortOrder>2</SortOrder>
    </PlaylistDetail>
    <PlaylistDetail>
      <Advert>
        <Created>2025-06-14T06:31:38.5310262+00:00</Created>
        <Deleted>true</Deleted>
        <Extension>sample string 3</Extension>
        <FileName>sample string 2</FileName>
        <FileSize>4</FileSize>
        <ID>1</ID>
        <ImageData>QEA=</ImageData>
        <IsVideo>true</IsVideo>
        <Length>7</Length>
        <Updated>2025-06-14T06:31:38.5310262+00:00</Updated>
      </Advert>
      <AdvertID>4</AdvertID>
      <Deleted>true</Deleted>
      <Duration>5</Duration>
      <ID>1</ID>
      <PlaylistID>3</PlaylistID>
      <SortOrder>2</SortOrder>
    </PlaylistDetail>
  </PlaylistDetails>
  <PlaylistGroups>
    <PlaylistGroup>
      <ID>1</ID>
      <PlaylistID>2</PlaylistID>
      <StoreID>3</StoreID>
      <ZoneID>4</ZoneID>
    </PlaylistGroup>
    <PlaylistGroup>
      <ID>1</ID>
      <PlaylistID>2</PlaylistID>
      <StoreID>3</StoreID>
      <ZoneID>4</ZoneID>
    </PlaylistGroup>
  </PlaylistGroups>
  <Priority>6</Priority>
  <Recurrence>1</Recurrence>
  <RecurrenceType>1</RecurrenceType>
  <StartDate>2025-06-14T06:31:38.5310262+00:00</StartDate>
  <StartTime>1</StartTime>
  <UpdatedByUser>sample string 4</UpdatedByUser>
  <WeekDays>1</WeekDays>
</Playlist>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.