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": "ccNQF/s8ZkC3kBatyY00Wg==", "identifierGuid": "1750c371-3cfb-4066-b790-16adc98d345a", "priority": 2, "createdUtc": "2025-08-02T23:15:59.6432796", "receivedUtc": "2025-08-02T23:15:59.6432796", "rsvpUtc": "2025-08-02T23:15:59.6432796", "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": [ "cf1e7e74-f60b-47cb-b843-d423fd1b5fa2", "bb1bc64f-e075-4775-b116-d627de64bd2e" ], "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-08-02T23:15:59.6432796+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>ccNQF/s8ZkC3kBatyY00Wg==</Identifier> <IdentifierGuid>1750c371-3cfb-4066-b790-16adc98d345a</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>cf1e7e74-f60b-47cb-b843-d423fd1b5fa2</d2p1:guid> <d2p1:guid>bb1bc64f-e075-4775-b116-d627de64bd2e</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-08-02T23:15:59.6432796+00:00</ReceivedUtc> <RsvpUtc>2025-08-02T23:15:59.6432796+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 ��[L\.� 5 xl/workbook.xml � (� ����0��&�C��-!Hp��Ճ��m�?ik��-%�x�3;��ԋq�ޘ��Y��5X�`+B� @q1t�M�)�tOb�IЙ�@�QZ3�h/��x������ j�P�K��� �zm����$���]MD��M� v\$�4W���Qrnc�F��q�SƮy���XBN����d��~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="R1112255a31f74e29" /></Relationships>PK ��[T�Zs� z xl/worksheets/sheet1.xml � (� ��Ys�@�� ��@���}���gF�@Eh0��O� �ti�6�߹�>�Ͼ҅���"��ȇ�=�M�,��G������x���G+UzϊA>��\°��*��@/Uf��:O��\�ϓ����U��2D �0W��4�*�dY��jߩU,sͪ�ŶT%�?�S}ӽ����?��7�{�xX��.����$����\��F>�ذO�����Lͣբ��*y�Kc�4S�(�O/M6��^}U��dV�f��0#� ��7]�N���M���z��c@H ��2!�8�ǵ��2�0D�H�#m�(�P*�#zZ��zV�ىz^�y�'�� H���zQ��}��N��e67��3�����4�'vw�����3� ���Є��6q�m���4�0����S��D��#&; �@py�B>��O�%�،*ᑇ6��G���&�UTF�a��^^m��չY�|2#�0��s���F[}v��>���U��]�O�.1��K�� �%n��w}Bt��>!�ă�1��Gb���@,[������}u ��o��64��E��B}������lW�����G0�L�?B�u���7���0��W�~YA�w V�b��@��<9+(��2�ŁX���b�v��-ܛj�yiS�D�R���۽H��PK ��[�rCB� P xl/_rels/workbook.xml.rels � (� ��An� E����@L�d�M�i.@`l����ٺ�z��Tj��n�B���h�|���ަ�@L�w��bN{3�^�s��m7{U.7�BB�KۜÚ��-L*U>�+���I�Rƞ�O����!q���Lt���wݠ����.�&�>���T�!K�%r=XU�=����oGap����nj)_FH�^��L�YRŏPCMW�5�]e��`�s,��;��Z�-Pր0����j��_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 ��[�x$�{ xl/sharedStrings.xml � (� ��oO�0ƿJ���ז�NItB�� �Wh�\�J=�v�T��cB������=��<��Mt �ʚ��I�"0�Je�*�Y�OY�č�5P��Egu�H���؞����(��9&����:���]��.q@�I'YV��+�"a;C���Ψ�,_���+ ��N�+S���Q �e�dH;e��>ԗ��!�k���|F�:��_��ox�����c��o!d�� ��͠+�pT����̪�=86C�'{eF��H������O��I&��<���6�eEo�,�.��TNg'<� �m~��_�hv$o|�o���x��Cz�[ڦ�����8%� �o~�|���t2���ŧ�?.�����7O������PK- ��[L\.� 5 xl/workbook.xmlPK- ��[���� � [Content_Types].xmlPK- ��[��Ǜ' ' V _rels/.relsPK- ��[T�Zs� z � xl/worksheets/sheet1.xmlPK- ��[�rCB� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E xl/styles.xmlPK- ��[�x$�{ � xl/sharedStrings.xmlPK � N
application/vnd.ms-excel
Sample:
PK ��[ĴĶ 5 xl/workbook.xml � (� ����0��J}�(��OPP`b�ڡ��� JR��/�ԭ��|�||������G��箠2�!g�75���L;a��0I�bV�`e��F��xL�����K5x���a��!�^"�/( ��r�#��͞ G�d�ug��%�~S<¶����� %ѹ�=Q�r5 ��K��-uz�,�{�q��.�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="R832e24bc578a49f3" /></Relationships>PK ��[T�Zs� z xl/worksheets/sheet1.xml � (� ��Ys�@�� ��@���}���gF�@Eh0��O� �ti�6�߹�>�Ͼ҅���"��ȇ�=�M�,��G������x���G+UzϊA>��\°��*��@/Uf��:O��\�ϓ����U��2D �0W��4�*�dY��jߩU,sͪ�ŶT%�?�S}ӽ����?��7�{�xX��.����$����\��F>�ذO�����Lͣբ��*y�Kc�4S�(�O/M6��^}U��dV�f��0#� ��7]�N���M���z��c@H ��2!�8�ǵ��2�0D�H�#m�(�P*�#zZ��zV�ىz^�y�'�� H���zQ��}��N��e67��3�����4�'vw�����3� ���Є��6q�m���4�0����S��D��#&; �@py�B>��O�%�،*ᑇ6��G���&�UTF�a��^^m��չY�|2#�0��s���F[}v��>���U��]�O�.1��K�� �%n��w}Bt��>!�ă�1��Gb���@,[������}u ��o��64��E��B}������lW�����G0�L�?B�u���7���0��W�~YA�w V�b��@��<9+(��2�ŁX���b�v��-ܛj�yiS�D�R���۽H��PK ��[lI<� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;q�C�M7l)p�q�ؑmJ9[=R�P�J�����h~OO��|����扼�u��-dI �0����^>�`��p�>L85.���ZP�/kJ�P8s��u�Hcg�Cj�pq��<M+jc�3����F�Q����L/ƞ�B�@���[�)9zY�@�}��w��jUˮ.xS�Ss�:�����c�<�Ƭd�+2�>TFq�����ұS\��2�EP�Y)dQJyS�w��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 ��[�x$�{ xl/sharedStrings.xml � (� ��oO�0ƿJ���ז�NItB�� �Wh�\�J=�v�T��cB������=��<��Mt �ʚ��I�"0�Je�*�Y�OY�č�5P��Egu�H���؞����(��9&����:���]��.q@�I'YV��+�"a;C���Ψ�,_���+ ��N�+S���Q �e�dH;e��>ԗ��!�k���|F�:��_��ox�����c��o!d�� ��͠+�pT����̪�=86C�'{eF��H������O��I&��<���6�eEo�,�.��TNg'<� �m~��_�hv$o|�o���x��Cz�[ڦ�����8%� �o~�|���t2���ŧ�?.�����7O������PK- ��[ĴĶ 5 xl/workbook.xmlPK- ��[���� � � [Content_Types].xmlPK- ��[��' ' U _rels/.relsPK- ��[T�Zs� z � xl/worksheets/sheet1.xmlPK- ��[lI<� P � xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E xl/styles.xmlPK- ��[�x$�{ � xl/sharedStrings.xmlPK � L