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": "Wsctyuie+US4BYrYeHvNcw==", "guid": "ca2dc75a-9ee8-44f9-b805-8ad8787bcd73", "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-08-02T23:27:01.3005752", "createdOn": "sample string 7", "updated": "2025-08-02T23:27:01.3005752" }
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-08-02T23:27:01.3005752+00:00</Created> <CreatedOn>sample string 7</CreatedOn> <Deleted>true</Deleted> <DisableScanner>true</DisableScanner> <G_UID>Wsctyuie+US4BYrYeHvNcw==</G_UID> <Guid>ca2dc75a-9ee8-44f9-b805-8ad8787bcd73</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-08-02T23:27:01.3005752+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
"2f2b99b3-5025-4083-ba80-1e042868d6af"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2f2b99b3-5025-4083-ba80-1e042868d6af</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK `�[ � 5 xl/workbook.xml � (� ��;�0D{$�`� 8��"rR������ld�㓏��ngv���хW�܋|�`cj�R�cQ(4OΣ�v��$Ó���['�mb�,���$�lT�G���aEdT��+ʀ��9�s���1.r2���I�b�)����Ek�BJ�&kz�$Tz� !e �+�������PK `�[���� � [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 `�[{�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="Re229a3ab37994f96" /></Relationships>PK `�[����% � xl/worksheets/sheet1.xml � (� �Q�N�0���w�v�QMm'�i�� �кM�&��t�瓤!q�Ė��{v��MO��)2 YMG�2c��*8��J��$�gn��6 ����N�.�M� d��!�#�aP��[4�wy��'ე�jv������E�,�i��Bh�^��Yx*��N�w����8�'�%&/}y��?�sR~���A,����(}��C��hr�fZŽ���U�^6PV�./��Ǫ������Il��%�h��Ix�֖VfS9��(��� �¼�6��5������~���L��&���k� PK `�[���� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�IlH��ݰa[z��=����.г��H\�H�J,�t5��ӓf>�?6��id/���l y&�������ۻ v�͞F�i"��XZ���>�y�y�=M27�M��� cJ}�g�G�B�s�d�5��3����v����i"� �W珡'���;�5����<KT`O��}�Q��4��0~3��#�_��|!��b��BW����2=z2�ѧK/���ڃ��l�VU�HA�Ư�b�PK `�[Ѓ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 `�[�,>z� � xl/sharedStrings.xml � (� 5�An� E��fO $�H�ɢRO� ����g\��/]t�������]V��;�J=�O�X�L�>�ߴŒhJk%���#fQmJ��"����%�nH-��^�4ܟ�������8k;SR&Pc=H��A����n��D7��~.�f�M_���!y��h��w~����`������PK- `�[ � 5 xl/workbook.xmlPK- `�[���� � � [Content_Types].xmlPK- `�[{�c�' ' U _rels/.relsPK- `�[����% � � xl/worksheets/sheet1.xmlPK- `�[���� P 8 xl/_rels/workbook.xml.relsPK- `�[Ѓc'2 E } xl/styles.xmlPK- `�[�,>z� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK `�[i�f� 5 xl/workbook.xml � (� ����0��&�C���R8q���{)�4П�5���H�yۙ��v�l��3����/]��lI�(�OƂ���8�C��EL�K�o:���q0� ������X�:� ��V��R��x@�-͞f�d4�����"�)�`�ERHsnx�%��U���+e�� Z�m�g4�r�w�cd�]PK `�[���� � [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 `�[�q=�' ' _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="R70b4d33762cd4d3b" /></Relationships>PK `�[����% � xl/worksheets/sheet1.xml � (� �Q�N�0���w�v�QMm'�i�� �кM�&��t�瓤!q�Ė��{v��MO��)2 YMG�2c��*8��J��$�gn��6 ����N�.�M� d��!�#�aP��[4�wy��'ე�jv������E�,�i��Bh�^��Yx*��N�w����8�'�%&/}y��?�sR~���A,����(}��C��hr�fZŽ���U�^6PV�./��Ǫ������Il��%�h��Ix�֖VfS9��(��� �¼�6��5������~���L��&���k� PK `�[x�[� P xl/_rels/workbook.xml.rels � (� ��An� E����`�N�M7٦� ���b�6g�G��R�%R�d��<������-3:��5����j2ǧ�:�ݬ�0��n�qr�'&p<�� r�E��:0���_DL���( �-�9�2����?D��$����&�&���1:?@��' �z�E�b�S��F���ceK㓻��x�!�z}י��5���]�0XUw���}�t�ǙZ[>�B�F�T�J˫���/PK `�[Ѓ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 `�[�,>z� � xl/sharedStrings.xml � (� 5�An� E��fO $�H�ɢRO� ����g\��/]t�������]V��;�J=�O�X�L�>�ߴŒhJk%���#fQmJ��"����%�nH-��^�4ܟ�������8k;SR&Pc=H��A����n��D7��~.�f�M_���!y��h��w~����`������PK- `�[i�f� 5 xl/workbook.xmlPK- `�[���� � [Content_Types].xmlPK- `�[�q=�' ' V _rels/.relsPK- `�[����% � � xl/worksheets/sheet1.xmlPK- `�[x�[� P 9 xl/_rels/workbook.xml.relsPK- `�[Ѓc'2 E � xl/styles.xmlPK- `�[�,>z� � � xl/sharedStrings.xmlPK � �