GET api/message/{id}?deserialiseDocument={deserialiseDocument}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
|
deserialiseDocument | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
MessageName | Description | Type | Additional information |
---|---|---|---|
Identifier | Collection of byte |
None. |
|
IdentifierGuid | globally unique identifier |
None. |
|
Priority | integer |
None. |
|
CreatedUtc | date |
None. |
|
ReceivedUtc |
Dismissed at |
date |
None. |
RsvpUtc |
Snoozed until |
date |
None. |
Sender | string |
String length: inclusive between 0 and 255 |
|
Action | MessageAction |
None. |
|
DocumentObject | Object |
None. |
|
Document | string |
None. |
|
DocumentType | string |
String length: inclusive between 0 and 255 |
|
External | boolean |
Relation. This field may not always be loaded or used for updates. |
|
Stores | Collection of integer |
Relation. This field may not always be loaded or used for updates. |
|
StoreName | string |
Relation. This field may not always be loaded or used for updates. |
|
Operators | Collection of globally unique identifier |
Relation. This field may not always be loaded or used for updates. |
|
Users | Collection of string |
Relation. This field may not always be loaded or used for updates. |
|
Machines | Collection of string |
Relation. This field may not always be loaded or used for updates. |
Response Formats
application/json, text/json
Sample:
{ "identifier": "jHxKkVOYCUmYqQLU68UlYA==", "identifierGuid": "914a7c8c-9853-4909-98a9-02d4ebc52560", "priority": 2, "createdUtc": "2025-06-14T06:36:13.6917583", "receivedUtc": "2025-06-14T06:36:13.6917583", "rsvpUtc": "2025-06-14T06:36:13.6917583", "sender": "sample string 4", "action": 1, "documentObject": { "$id": "2" }, "document": "sample string 6", "documentType": "sample string 7", "external": true, "stores": [ 1, 2 ], "storeName": "sample string 9", "operators": [ "bbbb2aea-8e71-40a4-9696-5d3269f28897", "2ad12d45-f3d5-4cb8-8025-6d26804b5781" ], "users": [ "sample string 1", "sample string 2" ], "machines": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<Message xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://gapsolutions.com.au/schema/ezimanager"> <Action>1</Action> <CreatedUtc>2025-06-14T06:36:13.6917583+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>jHxKkVOYCUmYqQLU68UlYA==</Identifier> <IdentifierGuid>914a7c8c-9853-4909-98a9-02d4ebc52560</IdentifierGuid> <Machines xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Machines> <Operators xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>bbbb2aea-8e71-40a4-9696-5d3269f28897</d2p1:guid> <d2p1:guid>2ad12d45-f3d5-4cb8-8025-6d26804b5781</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-06-14T06:36:13.6917583+00:00</ReceivedUtc> <RsvpUtc>2025-06-14T06:36:13.6917583+00:00</RsvpUtc> <Sender>sample string 4</Sender> <StoreName>sample string 9</StoreName> <Stores xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </Stores> <Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Users> </Message>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK �4�Z+��۶ 5 xl/workbook.xml � (� ����0��&�C��h���x��})[�@[ҭ�Ǘ�@������S�>t�����QJ�cr!Hj�@'?��v�q��%�RFb��ۢ��$W��h�#m�+� �%�m��,ǫぱbn�48�"'c�;�L�!�*�~�(��b�k�����ے�9���d*S�4R���I3��wX!���PK �4�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 �4�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="R5af993e8e7ca4283" /></Relationships>PK �4�Z��c.� z xl/worksheets/sheet1.xml � (� ��Y��0�� ��@��R�z��mf�� �B,���D���n_4T�sss8u���W��>U^$:�0 �����%���_��_�?�:�(b�J��Y1�G~\��A�X�Q����\�iT���=��y2UWz�JUV� �j��"N������Z�2WѬj!]lK�Q����,1�7�{����s8xC����'Q�bo�mn�O����l䃊 {�:�5�fj��o��U�{\�h���EQ�zi�������_'�26+P�!H�%���(u���n�l��֣����F�Q���q��;� ��:R�H�7 �$�J� B��zz���zv���z��I�) Ʉ��^�z�C�d���,��@ 8CIxXApb�p9�_A@*8�pJȑ M� ���a7��� 1�M���� M� 9��M�`�=b��0m �G*4�l�\B�͈��#��A���vxT��**��0�k/��M����,�j>��S�A�9��s����>��e�@]�O�.q�'H��� �%n���}�w��>!��}��]���e��\}r ������ŁXƾ:��7�Z�T���h���r�Xv_6�+V�{� �ĩL���_�|�q�o��v������rd�ށXU�eԣ����@��<;+(/���ՁX�x;�l��M��|��|�u��j��>$��PK �4�Z a�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8i�i��ݰa���3��&�e�@��G� XE�Tb�������4�y�Xoߧ��b���-TE �r�`�NI?,a�Y�p)OD3�H�-����ҨN"Σ���$RNCO�PG�#]�%�a[&9�=���>;u�Ц?��ͅc4� �A�S?�H��*2�K��N4��(��l�$k�л��t1�z}�3��sɞjD������ۧ�/=w��gjM����\/�d������PK �4�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 �4�ZQ��x xl/sharedStrings.xml � (� ��[O�0��J���]waEm����!؞!5,�IJ�N��B,��-=_���8����� X�F�l�, -L)�s�V����H\��2r����)pV�9[��Q�b �chjЎ<�8�O�am��� UEIO#ťf�0���%.������"d�Qq^�&�$�fY��䬑�O��4VR��s� A�"� 7�7u�|���u(� �W��h�kx���v�]����g'oV��ث^q�)���r;�BW��b-uO� Tx����0�����A:���4N݉��8)��(&�d�䪮��u��w��Os�;���xi�ΐ��榪��z1< V��B"=��8�4J:�NL�]�c�;��������+.�PK- �4�Z+��۶ 5 xl/workbook.xmlPK- �4�Z���� � � [Content_Types].xmlPK- �4�Z`���' ' U _rels/.relsPK- �4�Z��c.� z � xl/worksheets/sheet1.xmlPK- �4�Z a�� P � xl/_rels/workbook.xml.relsPK- �4�ZЃc'2 E xl/styles.xmlPK- �4�ZQ��x � xl/sharedStrings.xmlPK � F
application/vnd.ms-excel
Sample:
PK �4�Z�76�� 5 xl/workbook.xml � (� ����0��&�C�`�P��x��}��m�-ik���'�x�3;���u��ڎ}to|�J�!9羑�џ�@f� �4�I��B��jۼ5���(J�����K5xXi����[/���W�Fe�:+�fE�_�dlug��5�S��/�j*�ƀ��֖p�r5 �E�4����%�`gﰂo��/PK �4�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 �4�ZaTR�' ' _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="R22e3b59dea9a4686" /></Relationships>PK �4�Z��c.� z xl/worksheets/sheet1.xml � (� ��Y��0�� ��@��R�z��mf�� �B,���D���n_4T�sss8u���W��>U^$:�0 �����%���_��_�?�:�(b�J��Y1�G~\��A�X�Q����\�iT���=��y2UWz�JUV� �j��"N������Z�2WѬj!]lK�Q����,1�7�{����s8xC����'Q�bo�mn�O����l䃊 {�:�5�fj��o��U�{\�h���EQ�zi�������_'�26+P�!H�%���(u���n�l��֣����F�Q���q��;� ��:R�H�7 �$�J� B��zz���zv���z��I�) Ʉ��^�z�C�d���,��@ 8CIxXApb�p9�_A@*8�pJȑ M� ���a7��� 1�M���� M� 9��M�`�=b��0m �G*4�l�\B�͈��#��A���vxT��**��0�k/��M����,�j>��S�A�9��s����>��e�@]�O�.q�'H��� �%n���}�w��>!��}��]���e��\}r ������ŁXƾ:��7�Z�T���h���r�Xv_6�+V�{� �ĩL���_�|�q�o��v������rd�ށXU�eԣ����@��<;+(/���ՁX�x;�l��M��|��|�u��j��>$��PK �4�Z�_��� P xl/_rels/workbook.xml.rels � (� ���n� @���.5v'K��i~��m�$m��C?��P�H�#u��tw��;���c�}�'rFFkZZd9%h�U��[z������z��t"�$����!F�b,�g�uhRG[?CL��y�Y���K�e�����V�Qⳕ�M��^�?�1Rr �cl�O)��Pd�J�N�t/@.� ^�i}v7�/�_�k��Q�%vUӔ��Uf ��%���K�ey����QuJ��� ���n���PK �4�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 �4�ZQ��x xl/sharedStrings.xml � (� ��[O�0��J���]waEm����!؞!5,�IJ�N��B,��-=_���8����� X�F�l�, -L)�s�V����H\��2r����)pV�9[��Q�b �chjЎ<�8�O�am��� UEIO#ťf�0���%.������"d�Qq^�&�$�fY��䬑�O��4VR��s� A�"� 7�7u�|���u(� �W��h�kx���v�]����g'oV��ث^q�)���r;�BW��b-uO� Tx����0�����A:���4N݉��8)��(&�d�䪮��u��w��Os�;���xi�ΐ��榪��z1< V��B"=��8�4J:�NL�]�c�;��������+.�PK- �4�Z�76�� 5 xl/workbook.xmlPK- �4�Z���� � � [Content_Types].xmlPK- �4�ZaTR�' ' U _rels/.relsPK- �4�Z��c.� z � xl/worksheets/sheet1.xmlPK- �4�Z�_��� P � xl/_rels/workbook.xml.relsPK- �4�ZЃc'2 E xl/styles.xmlPK- �4�ZQ��x � xl/sharedStrings.xmlPK � H