GET api/pos/messages?Take={Take}&Skip={Skip}&Search={Search}&CountEvents={CountEvents}&OrderBy={OrderBy}&SortOrder={SortOrder}
Get matching PopupMessages
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Take |
Number of Popup Messages to take. If 0 or null returns all |
integer |
None. |
Skip |
Number of Popup Messages to skip |
integer |
None. |
Search |
Text to match against Popup Messages name / title |
string |
None. |
CountEvents |
Return the count of products and campaigns linked to Popup Message |
boolean |
None. |
OrderBy |
Column to sort Popup Messages by |
PopupMessageOrderBy |
None. |
SortOrder |
Sort Order |
SortOrder |
None. |
Body Parameters
None.
Response Information
Resource Description
PageList object containing matching Popup Messages
PageListOfPopupMessageName | Description | Type | Additional information |
---|---|---|---|
Type | string |
None. |
|
List | Collection of PopupMessage |
None. |
|
Skip |
Number of records to skip over |
integer |
None. |
Take |
Number of records to take |
integer |
None. |
TotalCount | integer |
Relation. This field may not always be loaded or used for updates. |
Response Formats
application/json, text/json
Sample:
{ "type": "PopupMessage", "list": [ { "$id": "2", "g_UID": "GKG+fu/0ukSquuy10Jx+TQ==", "guid": "7ebea118-f4ef-44ba-aaba-ecb5d09c7e4d", "name": "sample string 2", "title": "sample string 3", "assistanceRequired": true, "skipLights": true, "html": "sample string 4", "htmlWidth": 1, "htmlHeight": 1, "soundName": "sample string 5", "closeButtonText": "sample string 6", "highlight": true, "disableScanner": true, "timeout": 1, "deleted": true, "productCount": 1, "campaignCount": 1, "sellingRuleCount": 1, "created": "2025-06-14T06:48:50.7675549", "createdOn": "sample string 7", "updated": "2025-06-14T06:48:50.7675549" }, { "$ref": "2" } ], "skip": 1, "take": 1, "totalCount": 1 }
application/xml, text/xml
Sample:
<PageListOfPopupMessage3fVCERlp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Common"> <Skip>1</Skip> <Take>1</Take> <TotalCount>1</TotalCount> <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Pos.PopupMessage"> <d2p1:PopupMessage> <d2p1:AssistanceRequired>true</d2p1:AssistanceRequired> <d2p1:CampaignCount>1</d2p1:CampaignCount> <d2p1:CloseButtonText>sample string 6</d2p1:CloseButtonText> <d2p1:Created>2025-06-14T06:48:50.7675549+00:00</d2p1:Created> <d2p1:CreatedOn>sample string 7</d2p1:CreatedOn> <d2p1:Deleted>true</d2p1:Deleted> <d2p1:DisableScanner>true</d2p1:DisableScanner> <d2p1:G_UID>GKG+fu/0ukSquuy10Jx+TQ==</d2p1:G_UID> <d2p1:Guid>7ebea118-f4ef-44ba-aaba-ecb5d09c7e4d</d2p1:Guid> <d2p1:Highlight>true</d2p1:Highlight> <d2p1:Html>sample string 4</d2p1:Html> <d2p1:HtmlHeight>1</d2p1:HtmlHeight> <d2p1:HtmlWidth>1</d2p1:HtmlWidth> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:ProductCount>1</d2p1:ProductCount> <d2p1:SellingRuleCount>1</d2p1:SellingRuleCount> <d2p1:SkipLights>true</d2p1:SkipLights> <d2p1:SoundName>sample string 5</d2p1:SoundName> <d2p1:Timeout>1</d2p1:Timeout> <d2p1:Title>sample string 3</d2p1:Title> <d2p1:Updated>2025-06-14T06:48:50.7675549+00:00</d2p1:Updated> </d2p1:PopupMessage> <d2p1:PopupMessage> <d2p1:AssistanceRequired>true</d2p1:AssistanceRequired> <d2p1:CampaignCount>1</d2p1:CampaignCount> <d2p1:CloseButtonText>sample string 6</d2p1:CloseButtonText> <d2p1:Created>2025-06-14T06:48:50.7675549+00:00</d2p1:Created> <d2p1:CreatedOn>sample string 7</d2p1:CreatedOn> <d2p1:Deleted>true</d2p1:Deleted> <d2p1:DisableScanner>true</d2p1:DisableScanner> <d2p1:G_UID>GKG+fu/0ukSquuy10Jx+TQ==</d2p1:G_UID> <d2p1:Guid>7ebea118-f4ef-44ba-aaba-ecb5d09c7e4d</d2p1:Guid> <d2p1:Highlight>true</d2p1:Highlight> <d2p1:Html>sample string 4</d2p1:Html> <d2p1:HtmlHeight>1</d2p1:HtmlHeight> <d2p1:HtmlWidth>1</d2p1:HtmlWidth> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:ProductCount>1</d2p1:ProductCount> <d2p1:SellingRuleCount>1</d2p1:SellingRuleCount> <d2p1:SkipLights>true</d2p1:SkipLights> <d2p1:SoundName>sample string 5</d2p1:SoundName> <d2p1:Timeout>1</d2p1:Timeout> <d2p1:Title>sample string 3</d2p1:Title> <d2p1:Updated>2025-06-14T06:48:50.7675549+00:00</d2p1:Updated> </d2p1:PopupMessage> </List> </PageListOfPopupMessage3fVCERlp>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK 6�ZZ�� 5 xl/workbook.xml � (� ����0��&�C����N\�z��6�.ik���'�x�3;���#��&�����g��*�!�K����Ӯ%g Lҽ���X�|�A�Qt{��Wz�|����Ch�B�_Q�����X>7{j�"'c�;�L�!���~�(f�`�+���ܛ��9s������$�:�HS��wX.���PK 6�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 6�Z�c�/' ' _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="R1fd72d424d33466f" /></Relationships>PK 6�Z�/S$� xl/worksheets/sheet1.xml � (� ��M��0����{���Xm���[�C�� �b�N؟_cXv�DQ{���y�����ë��E+u_@aD_�Z���]�e�|��ŶB8����L[�N;�l� �m�O���Fŝ?�#�M#+���Y��!�q����W�V�,���K-{2�����R���y-}��=0�)�#�(���[��~�����_�Ï��8�h?��P���;�K߅<��) �Jw6|���� P�5�Y��G,�d��g�R��uZ=��*���z��IDӘ�ьd���g}�賈0��侎�:���d�%�����t�(N��ۛz4�-�x�/s�`B�W�Gڰ?l�W|)q�.�v&�� rM|[�د���8� ���^��w�t�I>y_�'�oč��wr�۹�)�0��?%a��v�,ϻ�PK 6�Z�h� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�I7��vÆm�&��&�e�@�Ƃ#q�"A*�`��h~OO��|����扽���5�� FZ�v�} ��=���m4a�~�gqE���s���'ƒ��θCL]�-���3!$wK�2��b�?D�u��G��3����w�Q vD�S����5�I�{jk8�*WT�5"˱����p���z}�����j���B䅤���}.^z�,/�Pb.S�t�&�S\]���_� PK 6�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 6�Z2�tP� � xl/sharedStrings.xml � (� e��N�0D��;� %�!*\�T�ᄐ��mb�^�����83z;�)��މ7HdVr� ) �0X+���]�HAlp0. Tr�b]�D,2�Tɉ9�jM�ސ 0'����,Ө)&0M 읾,�+�E)�0#W�Z���͏��.�����G��=X�Sow���������r�lC�cDf<�v1x����{@H�W�g^VO���hRm��ڴ��R��Ͽ-:�YPK- 6�ZZ�� 5 xl/workbook.xmlPK- 6�Z���� � � [Content_Types].xmlPK- 6�Z�c�/' ' U _rels/.relsPK- 6�Z�/S$� � xl/worksheets/sheet1.xmlPK- 6�Z�h� P � xl/_rels/workbook.xml.relsPK- 6�ZЃc'2 E � xl/styles.xmlPK- 6�Z2�tP� � o xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK 6�Z��?�� 5 xl/workbook.xml � (� ����@�{��r� &䠢���_`��O�����O ��ۙ��v�h\_ӳ���\λl�������]k��0I�Ӷ����oE:��|N�рA�;i=_i���u��V�B�yq<0&�fOI�_�dlug���ߔX`�Ţ�FE9/1 g�sorq�29 �6�Ui�qDxM�*�;{� �~_PK 6�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 6�Z�}�@' ' _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="R68f38db0bc924a3c" /></Relationships>PK 6�Z�/S$� xl/worksheets/sheet1.xml � (� ��M��0����{���Xm���[�C�� �b�N؟_cXv�DQ{���y�����ë��E+u_@aD_�Z���]�e�|��ŶB8����L[�N;�l� �m�O���Fŝ?�#�M#+���Y��!�q����W�V�,���K-{2�����R���y-}��=0�)�#�(���[��~�����_�Ï��8�h?��P���;�K߅<��) �Jw6|���� P�5�Y��G,�d��g�R��uZ=��*���z��IDӘ�ьd���g}�賈0��侎�:���d�%�����t�(N��ۛz4�-�x�/s�`B�W�Gڰ?l�W|)q�.�v&�� rM|[�د���8� ���^��w�t�I>y_�'�oč��wr�۹�)�0��?%a��v�,ϻ�PK 6�Z� �|� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8Η��ݰa[z��3��&vd�@�Ƃ#q�"A*�`��h~OO��|����扽��5-�$FF�~4C����a���i�'����-��ν�4�O�B&v�u3����/(�8�Ҵ�ǹk&;���*5Jz��4� ���uG�����B?%�/A$� �oa�� �aYt]��L͇�D���;_�t�H��H�(�V7���.^z�.�Ԩ)�"��odY�&����~PK 6�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 6�Z2�tP� � xl/sharedStrings.xml � (� e��N�0D��;� %�!*\�T�ᄐ��mb�^�����83z;�)��މ7HdVr� ) �0X+���]�HAlp0. Tr�b]�D,2�Tɉ9�jM�ސ 0'����,Ө)&0M 읾,�+�E)�0#W�Z���͏��.�����G��=X�Sow���������r�lC�cDf<�v1x����{@H�W�g^VO���hRm��ڴ��R��Ͽ-:�YPK- 6�Z��?�� 5 xl/workbook.xmlPK- 6�Z���� � � [Content_Types].xmlPK- 6�Z�}�@' ' U _rels/.relsPK- 6�Z�/S$� � xl/worksheets/sheet1.xmlPK- 6�Z� �|� P � xl/_rels/workbook.xml.relsPK- 6�ZЃc'2 E � xl/styles.xmlPK- 6�Z2�tP� � n xl/sharedStrings.xmlPK � �