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": "XHc/NNfkKkmqyN31PMEblA==", "guid": "343f775c-e4d7-492a-aac8-ddf53cc11b94", "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:17:01.9126641", "createdOn": "sample string 7", "updated": "2025-06-14T06:17:01.9126641" }
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-06-14T06:17:01.9126641+00:00</Created> <CreatedOn>sample string 7</CreatedOn> <Deleted>true</Deleted> <DisableScanner>true</DisableScanner> <G_UID>XHc/NNfkKkmqyN31PMEblA==</G_UID> <Guid>343f775c-e4d7-492a-aac8-ddf53cc11b94</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-06-14T06:17:01.9126641+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
"d2f65744-d4e0-46e7-a4a9-ff14d76bd964"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">d2f65744-d4e0-46e7-a4a9-ff14d76bd964</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK 2�Z��eQ� 5 xl/workbook.xml � (� ����0��&�C��R�Q��x�པ�m�?ik��-H�yۙ��v�����v@=�P��]IH�4'�����^���+���Z��`"���xYT��\�+�VpX$@���L�Us���),2[��Dd ��T����E!�4Ըe�a�8���F�Tix���� �т�)��wXE���PK 2�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 2�Z) *1' ' _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="R1eeb881050c84f3c" /></Relationships>PK 2�Zs`��% � xl/worksheets/sheet1.xml � (� �Q�n� ��}!M�6��T��j�M;lg�85����? �4i� [~~��T��� ��hk��r����i;�|���䧦Z�]� ��]��t· ��N`C�Gg$�� �^�p�v6`Iy�FIA�+=y�����Od�,�q�2R[�T���=s���iÙh��|װ�_1�c|"^c���<OX�|Iʯ�u��y�7\�A�v���ѧ��ƙ���.�#U��!;�e��7������'4kyu)V��y�$����\*��y|r�}���䕸��p���گ�] \R����PK 2�Z8�HR� P xl/_rels/workbook.xml.rels � (� ���N!�_��݅�讦�^�x�}��Mw� U�l|$_AR��/=���|����c�}[f�!N�vPWZ��d���ܴ�ݬw8˔o�q��'6v0��(�j�E��y��c\Xd�e��� ���;J\2����?Dg̤�ѩ�6���.∘��e0u�Ez>�*S�<�v��U{�j�{.�J�WS��4c�����ٰ�nZ&���UeFP?��7]:�q9'ɍ�5����i�j��_l� PK 2�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 2�Z�T=�� � xl/sharedStrings.xml � (� 5�An� E��fOp"�� �E�� 9 5���g\��Yt�������[���J(���L�n�/��%R�K%��%xfQmJ<�,�~��%�H-��V�4��� c�Q�bN]�L��@�u'iZP;�ǎ���9x �4���Z�,v�:�u���hS���Yo$x���*<PK- 2�Z��eQ� 5 xl/workbook.xmlPK- 2�Z���� � [Content_Types].xmlPK- 2�Z) *1' ' V _rels/.relsPK- 2�Zs`��% � � xl/worksheets/sheet1.xmlPK- 2�Z8�HR� P 9 xl/_rels/workbook.xml.relsPK- 2�ZЃc'2 E � xl/styles.xmlPK- 2�Z�T=�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK 2�Zo �� 5 xl/workbook.xml � (� ���� D�M��(h�M�z��k��,�(`��~~�Io���ξ�z�n��GO�W��2��"�4�;��;a�f!J�"V5@g��HNiIL,(k�T�����0�%@�ӆ�LܞO�k����'���j"���o�N��")d��w,0��s� �0r��Ãg9�Kzey+ ��}�j��n�PK 2�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 2�Z�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="Rd4a37a3832b545f7" /></Relationships>PK 2�Zs`��% � xl/worksheets/sheet1.xml � (� �Q�n� ��}!M�6��T��j�M;lg�85����? �4i� [~~��T��� ��hk��r����i;�|���䧦Z�]� ��]��t· ��N`C�Gg$�� �^�p�v6`Iy�FIA�+=y�����Od�,�q�2R[�T���=s���iÙh��|װ�_1�c|"^c���<OX�|Iʯ�u��y�7\�A�v���ѧ��ƙ���.�#U��!;�e��7������'4kyu)V��y�$����\*��y|r�}���䕸��p���گ�] \R����PK 2�Z���X� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8�Ӡ��tö�������n�gc���V� �X��j4��'�|���o�H����l,ˁ�UN�k��� ���G�D�9��bC}���A�8���m��'S�;:u�"�9�K�2��2��ΘA�Ωӄ6����C����0��S �X��@�u{͊\���p^���@���B��~���L!����Z�ʔ�dw��G�}���iY^��X��nj#Kl�U�����PK 2�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 2�Z�T=�� � xl/sharedStrings.xml � (� 5�An� E��fOp"�� �E�� 9 5���g\��Yt�������[���J(���L�n�/��%R�K%��%xfQmJ<�,�~��%�H-��V�4��� c�Q�bN]�L��@�u'iZP;�ǎ���9x �4���Z�,v�:�u���hS���Yo$x���*<PK- 2�Zo �� 5 xl/workbook.xmlPK- 2�Z���� � � [Content_Types].xmlPK- 2�Z�z�)' ' U _rels/.relsPK- 2�Zs`��% � � xl/worksheets/sheet1.xmlPK- 2�Z���X� P 8 xl/_rels/workbook.xml.relsPK- 2�ZЃc'2 E xl/styles.xmlPK- 2�Z�T=�� � � xl/sharedStrings.xmlPK � �