POST api/playlists
Add a playlist
Request Information
URI Parameters
None.
Body Parameters
PlaylistName | Description | 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:25:00.6287144", "startTime": 1, "endDate": "2025-06-14T06:25:00.6287144", "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:25:00.6287144", "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:25:00.6287144", "updated": "2025-06-14T06:25:00.6287144", "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:25:00.6287144+00:00</EndDate> <EndTime>1</EndTime> <ID>1</ID> <LastUpdated>2025-06-14T06:25:00.6287144+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:25:00.6287144+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:25:00.6287144+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:25:00.6287144+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:25:00.6287144+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:25:00.6287144+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
int
integerResponse Formats
application/json, text/json
Sample:
1
application/xml, text/xml
Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK 3�Z�V�K� 5 xl/workbook.xml � (� ����0D�&�C����N\�z��6Ж�5��$��ξ>Z�=���G����2��`����h⮵NC�ҽ�m[%�����&ə9�!(k�T����B�%b���Ҡ��;B���p���Zw2 [B�7�g�v1+b@cIk@��ܚ�)q���]�I�6��䐝rq�{�q����PK 3�Z���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK 3�Z�d�v' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R0aa893d4a12c4e6e" /></Relationships>PK 3�Z��4 � xl/worksheets/sheet1.xml � (� �Q�n� ��}%��j�U���n�ۙ%N@ 82����6M�e������<��Ȯ@��ox��8�bg���9�w����t ��aO 71N{!Bk��� |z둜�)�A`��N��|۪� �Q�T*;���G+L�+ܸJ9m=W��I=�g}Ï5gBɂ|���_1�m|"^r��5�*X�|.�_�u��y�o�<�LLz(��Pv�l�gN�ʹ�.��?m��j�M�v��z��+��:騕$\�礚��G����Z�kf���ߎW�Is:#F����W�PK 3�Z)��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�Mb���ݰ���xGM��v=�����ĂMW��==i���c�yv&zgXdYt��]��>T�Y�v4��&���Ҋ ��'�U��D6uZ�GS�;>)<��x.�#�s�2��2���m{�g���l��_�?C���(6�S �Y���v(E�k:,�*J�0~7�/�_��|&#�<ԵTX��w�1ʓ~�>]z�4/���P�u�sY�UMW5~��/PK 3�ZЃc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK 3�Z�/�� � xl/sharedStrings.xml � (� 5�A� �B�nA�h&�@@ڵ����������d2;}Ҧ�X9frp(�9/�V���p��i�[&t�E5��YTO��r՚���R7�\���u�\*����M��9��#��s#qЧ��������~PK- 3�Z�V�K� 5 xl/workbook.xmlPK- 3�Z���� � � [Content_Types].xmlPK- 3�Z�d�v' ' U _rels/.relsPK- 3�Z��4 � � xl/worksheets/sheet1.xmlPK- 3�Z)��� P - xl/_rels/workbook.xml.relsPK- 3�ZЃc'2 E s xl/styles.xmlPK- 3�Z�/�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK 3�Z���s� 5 xl/workbook.xml � (� ����0D�J��(�Z��K�� �&�$(IE?�R�n�����l��X;���/\IeS��o%j�;����: !J�b��U��m�M`)�s8BP�x�&O7�?,?9��KĠ� �AZ�O����S��W���b���oJ���bUĀƒ���չw%M(q���#K;Γ�I��o����>`���/PK 3�Z���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK 3�Zd�(' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="Re4027822aa3443ca" /></Relationships>PK 3�Z��4 � xl/worksheets/sheet1.xml � (� �Q�n� ��}%��j�U���n�ۙ%N@ 82����6M�e������<��Ȯ@��ox��8�bg���9�w����t ��aO 71N{!Bk��� |z둜�)�A`��N��|۪� �Q�T*;���G+L�+ܸJ9m=W��I=�g}Ï5gBɂ|���_1�m|"^r��5�*X�|.�_�u��y�o�<�LLz(��Pv�l�gN�ʹ�.��?m��j�M�v��z��+��:騕$\�礚��G����Z�kf���ߎW�Is:#F����W�PK 3�Z@�M3� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞��I(j� ��p�q5�#�z6�+` \���F�{z�����z�6O�C�k�W:���������v���R��øD�W\laHiy�4�g+����ìRNCO��G*�i(p�$�ӂ�!zkG��^gt�0}���d�B����R����L�dZ���0ƛN�*&U��Ы��t�0�z}��1w+���n�2� h�Sȗ.��r��:�q���e�g5z��/PK 3�ZЃc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK 3�Z�/�� � xl/sharedStrings.xml � (� 5�A� �B�nA�h&�@@ڵ����������d2;}Ҧ�X9frp(�9/�V���p��i�[&t�E5��YTO��r՚���R7�\���u�\*����M��9��#��s#qЧ��������~PK- 3�Z���s� 5 xl/workbook.xmlPK- 3�Z���� � � [Content_Types].xmlPK- 3�Zd�(' ' U _rels/.relsPK- 3�Z��4 � � xl/worksheets/sheet1.xmlPK- 3�Z@�M3� P - xl/_rels/workbook.xml.relsPK- 3�ZЃc'2 E r xl/styles.xmlPK- 3�Z�/�� � � xl/sharedStrings.xmlPK � �