POST api/pos/message
Add or update a PopupMessage
Request Information
URI Parameters
None.
Body Parameters
Popup Message object to save
PopupMessage| Name | 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": "y289haSLHEG4TDA46z9qqQ==",
"guid": "853d6fcb-8ba4-411c-b84c-3038eb3f6aa9",
"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": "2026-04-03T06:24:58.3607357",
"createdOn": "sample string 7",
"updated": "2026-04-03T06:24:58.3607357"
}
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>2026-04-03T06:24:58.3607357+00:00</Created> <CreatedOn>sample string 7</CreatedOn> <Deleted>true</Deleted> <DisableScanner>true</DisableScanner> <G_UID>y289haSLHEG4TDA46z9qqQ==</G_UID> <Guid>853d6fcb-8ba4-411c-b84c-3038eb3f6aa9</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>2026-04-03T06:24:58.3607357+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
"06311672-a1ea-4446-ba7b-9e43bc9b6728"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">06311672-a1ea-4446-ba7b-9e43bc9b6728</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK 3�\��� 5 xl/workbook.xml � (� ����0D�&�C��@��x��}��m�-����%�x�3;�v����ù���R�k�BK!�Sh�NnD;���,�S8)u����mY��� A;KJ��W�?,=BO
1�aEЖ7�c���q�(gc���L�!�"l���Y0X�p�k_�3_�y��}����"��,��wX%���PK 3�\���� � [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�\Qj&' ' _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="Rbbf35661cb1147c5" /></Relationships>PK 3�\��o�% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%i�,��T��j�M;lg�85�Ȑ��? �4i� [~~��Tǻ�
�i�5�7g`[�j>����ǦZ��Nx������� �k�68�
��HR��n��l�z�ͲB��)������.7�.Y0�Je����:أ{F����s&�*!�5,�W����ט�t5�V�_��+�z9��
�gЃ�aC������͌�{���{z�yU�]�)�,��"��wO����h>���R�4I�,�l*
Q*��y\r�]���d����p���گ�.�()��\�PK 3�\�M]� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8n⢦ݰa[z�'Q۲]�gc���V���X��j4��'�|�lvo�L^0���XUA������)�;��f��Ly"���$���Ø��4�+���qa�)�a�^���6u��P2�Ig��!:c&��N���0}u�G�� À���R����L�{�3�ek8k;��i�Л��t�1�z}���Z�N0L3Ι���(���K��\�u��F�V���\_���_l� PK 3�\Ѓ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�\x0��� � xl/sharedStrings.xml � (� 5�A��0�b��8�(��1$^�<`��K�8d&��=��[խjy�ټh����zW�!������fO`D�G�3S�$`.���)S�&���9&J(���ׄZ��p����LD�f����%�f�kт�8>7���"��k��C]�ǽŚ�6M����=Ss�s_��;
���]y>PK- 3�\��� 5 xl/workbook.xmlPK- 3�\���� � � [Content_Types].xmlPK-
3�\Qj&' ' U _rels/.relsPK- 3�\��o�% � � xl/worksheets/sheet1.xmlPK- 3�\�M]� P 8 xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
~ xl/styles.xmlPK- 3�\x0��� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK 3�\�%c� 5 xl/workbook.xml � (� ����0��&�C��U#)��x���V�O�||K $���~;l2nh��G����}� ķ=(�Ƃ�;a��!J�"F�BmڷȉҜ8y�F�^Z��?,o��� A�Jq�q��!��fO �O2k��Dd ��K��")����<p��s�J|��2�L47ډ,�o�3�4xco0F���PK 3�\���� � [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�\QIj�' ' _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="Rb27ce6858e23402f" /></Relationships>PK 3�\��o�% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%i�,��T��j�M;lg�85�Ȑ��? �4i� [~~��Tǻ�
�i�5�7g`[�j>����ǦZ��Nx������� �k�68�
��HR��n��l�z�ͲB��)������.7�.Y0�Je����:أ{F����s&�*!�5,�W����ט�t5�V�_��+�z9��
�gЃ�aC������͌�{���{z�yU�]�)�,��"��wO����h>���R�4I�,�l*
Q*��y\r�]���d����p���گ�.�()��\�PK 3�\�c��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞ة�|��ݰa[z�'Q۲]�gc���V� �X��j4��'�|�l�o�D^Їњ�A�l7���s�5�w�N"��0�.��bBC�nCiP�"d֡Im�,bJ}O�P'�#]1VR�d�-�/�C�Z�
�:�h�`�j�)��Q�c?�@�!��S�kٰN�l���%z7�/�_��|!#�dM�ԺVe����2���=G�.�tZ�j�Uz�;�8�
��Fo�b�PK 3�\Ѓ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�\x0��� � xl/sharedStrings.xml � (� 5�A��0�b��8�(��1$^�<`��K�8d&��=��[խjy�ټh����zW�!������fO`D�G�3S�$`.���)S�&���9&J(���ׄZ��p����LD�f����%�f�kт�8>7���"��k��C]�ǽŚ�6M����=Ss�s_��;
���]y>PK- 3�\�%c� 5 xl/workbook.xmlPK- 3�\���� � [Content_Types].xmlPK-
3�\QIj�' ' V _rels/.relsPK- 3�\��o�% � � xl/worksheets/sheet1.xmlPK- 3�\�c��� P 9 xl/_rels/workbook.xml.relsPK- 3�\Ѓc'2 E
� xl/styles.xmlPK- 3�\x0��� � � xl/sharedStrings.xmlPK � �