POST api/pos/message
Add or update a PopupMessage
Request Information
URI Parameters
None.
Body Parameters
Popup Message object to save
PopupMessageName | Description | Type | Additional information |
---|---|---|---|
G_UID |
Dialog message identifier |
Collection of byte |
None. |
Guid |
Text version of dialog message identifier |
globally unique identifier |
None. |
Name |
Dialog message name |
string |
String length: inclusive between 0 and 40 |
Title |
The text that is displayed at the top of the dialog prompt |
string |
String length: inclusive between 0 and 60 |
AssistanceRequired |
if true an operator has to scan to dismiss the prompt |
boolean |
None. |
SkipLights |
if true self-serve lights will not change colour when the prompt is displayed |
boolean |
None. |
Html |
The html that will be rendered on the form, if null or empty no html box will be displayed) |
string |
None. |
HtmlWidth |
Width of html box, between 200-1000px, default is 700px |
integer |
None. |
HtmlHeight |
height of html box, between 200-1000px, default is 400px |
integer |
None. |
SoundName |
The name of the local sound file that will be played when the form is open |
string |
String length: inclusive between 0 and 191 |
CloseButtonText |
Text displayed on the close button, defaults to 'Close' |
string |
String length: inclusive between 0 and 20 |
Highlight |
If true the dialog will be highlighted (background dimmed) |
boolean |
None. |
DisableScanner |
if true the scanner will be disabled while the form is displayed |
boolean |
None. |
Timeout |
The length of time in seconds the form will be displayed for (if 0 the form will not timeout) |
integer |
None. |
Deleted |
Soft deletion flag |
boolean |
None. |
ProductCount |
product count |
integer |
None. |
CampaignCount |
campaign count |
integer |
None. |
SellingRuleCount |
selling rule count |
integer |
None. |
Created |
Creation date |
date |
None. |
CreatedOn |
text version of creation date, dd/mm/yyyy |
string |
None. |
Updated |
Last updated date |
date |
None. |
Request Formats
application/json, text/json
{ "g_UID": "q+iEzl+hoEqd5MqjGrqURg==", "guid": "ce84e8ab-a15f-4aa0-9de4-caa31aba9446", "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-10-04T23:56:27.9097897", "createdOn": "sample string 7", "updated": "2025-10-04T23:56:27.9097897" }
application/xml, text/xml
<PopupMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Pos.PopupMessage"> <AssistanceRequired>true</AssistanceRequired> <CampaignCount>1</CampaignCount> <CloseButtonText>sample string 6</CloseButtonText> <Created>2025-10-04T23:56:27.9097897+00:00</Created> <CreatedOn>sample string 7</CreatedOn> <Deleted>true</Deleted> <DisableScanner>true</DisableScanner> <G_UID>q+iEzl+hoEqd5MqjGrqURg==</G_UID> <Guid>ce84e8ab-a15f-4aa0-9de4-caa31aba9446</Guid> <Highlight>true</Highlight> <Html>sample string 4</Html> <HtmlHeight>1</HtmlHeight> <HtmlWidth>1</HtmlWidth> <Name>sample string 2</Name> <ProductCount>1</ProductCount> <SellingRuleCount>1</SellingRuleCount> <SkipLights>true</SkipLights> <SoundName>sample string 5</SoundName> <Timeout>1</Timeout> <Title>sample string 3</Title> <Updated>2025-10-04T23:56:27.9097897+00:00</Updated> </PopupMessage>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
PopupMessage guid of the object
globally unique identifierResponse Formats
application/json, text/json
"5ee2e241-e86e-4d0c-bf9b-8fab4f3298c8"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5ee2e241-e86e-4d0c-bf9b-8fab4f3298c8</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK �D[W��� 5 xl/workbook.xml � (� ����0D�&�C��@DR8q����J�������Ϸ@ ��mgv������ù�����7T�8�^��pr#ڴ���I�'sR�; �Ȋ,�0�D�lPzt��� �GA!F3�(���x �������dlug��5�~S|���"6���,�U44���: ���+! )�sY!��;���w�PK �D[���� � [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 �D[�f' ' _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="R0d8e9827d7e040e9" /></Relationships>PK �D[��% � xl/worksheets/sheet1.xml � (� �QMo� �+�� iՏUI�IU�ݦ�3K��p�Iӟ? �4i� [~~�ٔ��� <t/V�3p ����B�p৺��_Iᎎ��:��(5����b�CoU���v�i��d���r'<*D)�f$�����F���PYe���D��y�*�Tp&�2#� ��+fi�O�kJ^ڊˌ�����Y�����3�^���m�ip�|3k��8���ٴAW|�_m���,6rWlל5�Kyq)��yVAեǙ�\��)J�Pv�)�{�e)n�7������%�� >+��\�PK �D[s��>� P xl/_rels/workbook.xml.rels � (� ��An� E��f_c���8�t�m�L`0Vl����ٺ�z��Fj��n�B���f�|�Xm�Ɓ�ɇ��D�#+��m��)�%l֫ Ӎ`�)��ĆL���A1dn"�:��c*}�'�G�y�����L��L��Ӻ����i$� �W��E`{��~����%*��jaWU��V��J�UM����B�~���LfQS��Xʂʲiw�1�I�D�6=w��3����˃D�(^��o���PK �D[Ѓ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 �D[ �m� � xl/sharedStrings.xml � (� 5�An�0E�b��1�4r*�,"����%<���������������čS���R,c�G��X�a)�=�"��x�,�N�{�E�/c8ΘʊT��l9H��ax�0�<#J^L�4'�C"P��$Uj������ y'��Ŷ;j�'���D=L�A�)��ўm�Έw�o�+�PK- �D[W��� 5 xl/workbook.xmlPK- �D[���� � � [Content_Types].xmlPK- �D[�f' ' U _rels/.relsPK- �D[��% � � xl/worksheets/sheet1.xmlPK- �D[s��>� P 8 xl/_rels/workbook.xml.relsPK- �D[Ѓc'2 E xl/styles.xmlPK- �D[ �m� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK �D[�e�ڷ 5 xl/workbook.xml � (� ����0D�J��(� �R!`b�ڡ� �D�%���7�ԭ��|~�r�fl��GN����ss���J�=��^ �K�b���F�D�XEWfp'����-�h���l:; :9m( B��|"�\�=.6Ho�uW��-�~Se�A+ڀJ�s�*Sb �G��C���4K�8����l�]PK �D[���� � [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 �D[��3' ' _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="R790aaf473186472a" /></Relationships>PK �D[��% � xl/worksheets/sheet1.xml � (� �QMo� �+�� iՏUI�IU�ݦ�3K��p�Iӟ? �4i� [~~�ٔ��� <t/V�3p ����B�p৺��_Iᎎ��:��(5����b�CoU���v�i��d���r'<*D)�f$�����F���PYe���D��y�*�Tp&�2#� ��+fi�O�kJ^ڊˌ�����Y�����3�^���m�ip�|3k��8���ٴAW|�_m���,6rWlל5�Kyq)��yVAեǙ�\��)J�Pv�)�{�e)n�7������%�� >+��\�PK �D[.a� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�Nl���ݰa[zǙ|�Ďl��Xp$��U$p%l:��|��$����f�������i�gm�� �BW�n���B���z�����@��#.�gvE'�u� �t]�>�i��=u)���p^�?D����G�O����Zw�#b rPn���O��K�Y�y���\�Zɶj�%@���|8�����D�1��J�\�B���̨v��şN��v���Rt5�s-b0~Q�Ww��PK �D[Ѓ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 �D[ �m� � xl/sharedStrings.xml � (� 5�An�0E�b��1�4r*�,"����%<���������������čS���R,c�G��X�a)�=�"��x�,�N�{�E�/c8ΘʊT��l9H��ax�0�<#J^L�4'�C"P��$Uj������ y'��Ŷ;j�'���D=L�A�)��ўm�Έw�o�+�PK- �D[�e�ڷ 5 xl/workbook.xmlPK- �D[���� � [Content_Types].xmlPK- �D[��3' ' V _rels/.relsPK- �D[��% � � xl/worksheets/sheet1.xmlPK- �D[.a� P 9 xl/_rels/workbook.xml.relsPK- �D[Ѓc'2 E � xl/styles.xmlPK- �D[ �m� � � xl/sharedStrings.xmlPK � �