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": "ExAFKuhQf02Dlnxfu4NLcw==",
"guid": "2a051013-50e8-4d7f-8396-7c5fbb834b73",
"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-06-03T18:36:30.9979201",
"createdOn": "sample string 7",
"updated": "2026-06-03T18:36:30.9979201"
}
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-06-03T18:36:30.9979201+00:00</Created> <CreatedOn>sample string 7</CreatedOn> <Deleted>true</Deleted> <DisableScanner>true</DisableScanner> <G_UID>ExAFKuhQf02Dlnxfu4NLcw==</G_UID> <Guid>2a051013-50e8-4d7f-8396-7c5fbb834b73</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-06-03T18:36:30.9979201+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
"80507a46-546a-42a4-b48e-0210624dfb33"
application/xml, text/xml
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">80507a46-546a-42a4-b48e-0210624dfb33</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PK ���\� �� 5 xl/workbook.xml � (� ����0��&�C�p��18q����[i�?ik��H�yۙ��v�ɸWk̋}Ԩ}�*>�` �
�П�%=�q
�,�����toE:@�$p4b�F�AZ�W�?,oa�����Pj^��K����G9[��d���7UF�~Ө��
�,:���)g���pW��>I��<����V����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
���\ڧ�' ' _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="R1f07bc57ddd647a4" /></Relationships>PK ���\�'y�% � xl/worksheets/sheet1.xml � (� �QMo� �+��B���JRM���6��Y�Ԁ#L���ѦI�� ���{Ϧ<���n�H���*�9�`�m_��w?���J
�� �ttWޏG!�Q`$e8�
���>���u��36���:���� }�"�G���ht �d�����lu`���O+�D]&仆�~�,��x��K[�<a��%)�:�B'������W>lh�z(���7Ό��w֭W��n�/�8�-g�D��R^\��&i���u�pf.�{��<��q
�����N��_�U����~~��PK ���\����� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b͞� 12����n)���$"�#۴�l]�H�B-*�A�V��==i���c��B!��5P9�M����.�w�
��D��)���b]Jӆ�;1~"�;ևSNC�'�'l�WB�x�3�Ɏ���C�����>���`���)vD �CK���R��P�
��4p���ڈ�J|�`�nj1]��^��L�"�k�VkS��*�a �B���i^�����dK"Y+�����}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 ���\��Ů � xl/sharedStrings.xml � (� 5�A��0�b�nl��F+��x��!��x2�_�a���Vu8��^�r*����i�4�1ѣ�?�ba.��� ku��YT��zY���a��+RM�e� ׇ�eEyB�<�ƹ�fH��P6���j������U�b�ع��ߚ�o������k��m�x��J��o��PK- ���\� �� 5 xl/workbook.xmlPK- ���\���� � � [Content_Types].xmlPK-
���\ڧ�' ' U _rels/.relsPK- ���\�'y�% � � xl/worksheets/sheet1.xmlPK- ���\����� P 8 xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
} xl/styles.xmlPK- ���\��٠� � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
PK ���\�'m)� 5 xl/workbook.xml � (� ����0��&�C���
�N\�z�^`+
�'m
>��o�vfg�:k;�Z��#'�J[��{S�$s'm@��V2�}���[��$K��X��Z�A�W�?,g,��
^N+J2�p}< D�fO��2[��Dd
�����"*���
7�3��s�+�bdK��
z(�k�'Yz9���;���w�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
���\&~,�' ' _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="Re1fea09c95854acd" /></Relationships>PK ���\�'y�% � xl/worksheets/sheet1.xml � (� �QMo� �+��B���JRM���6��Y�Ԁ#L���ѦI�� ���{Ϧ<���n�H���*�9�`�m_��w?���J
�� �ttWޏG!�Q`$e8�
���>���u��36���:���� }�"�G���ht �d�����lu`���O+�D]&仆�~�,��x��K[�<a��%)�:�B'������W>lh�z(���7Ό��w֭W��n�/�8�-g�D��R^\��&i���u�pf.�{��<��q
�����N��_�U����~~��PK ���\9!�� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;��q�M7l)p�I�ؑmJ9[=R�P�Jm����h~OO��|���ަ����5҄A�l;�^�9tOv��G����I\1^�a^S��I���hb��n�!����T'�#�+�[2�I���C�]7(|��<� ��ź��Q��������&�
d�
8��bUMɲ4_u5�05�#�_��|!S�Hy� �U�d�Ce�tؾ/�tZ�j�6�8�%�y�KU����_l� 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 ���\��Ů � xl/sharedStrings.xml � (� 5�A��0�b�nl��F+��x��!��x2�_�a���Vu8��^�r*����i�4�1ѣ�?�ba.��� ku��YT��zY���a��+RM�e� ׇ�eEyB�<�ƹ�fH��P6���j������U�b�ع��ߚ�o������k��m�x��J��o��PK- ���\�'m)� 5 xl/workbook.xmlPK- ���\���� � [Content_Types].xmlPK-
���\&~,�' ' V _rels/.relsPK- ���\�'y�% � � xl/worksheets/sheet1.xmlPK- ���\9!�� P 9 xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
� xl/styles.xmlPK- ���\��٠� � xl/sharedStrings.xmlPK � �