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": "iWU9boQkHU2t0MjgxXS11A==", "identifierGuid": "6e3d6589-2484-4d1d-add0-c8e0c574b5d4", "priority": 2, "createdUtc": "2025-10-04T23:59:59.5753375", "receivedUtc": "2025-10-04T23:59:59.5753375", "rsvpUtc": "2025-10-04T23:59:59.5753375", "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": [ "87a95be3-53d1-4f9c-b1aa-bdb0e2f8a643", "ff70cdde-5149-4368-8095-2fef645eaea7" ], "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-10-04T23:59:59.5753375+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>iWU9boQkHU2t0MjgxXS11A==</Identifier> <IdentifierGuid>6e3d6589-2484-4d1d-add0-c8e0c574b5d4</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>87a95be3-53d1-4f9c-b1aa-bdb0e2f8a643</d2p1:guid> <d2p1:guid>ff70cdde-5149-4368-8095-2fef645eaea7</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-10-04T23:59:59.5753375+00:00</ReceivedUtc> <RsvpUtc>2025-10-04T23:59:59.5753375+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 }�D[�W�� 5 xl/workbook.xml � (� ����0D�&�C��P N\�z��" �%m ~��o�vfg�N>k3�Z�#Ge3S�)c�6=J�'=��N �K�b��D��n��c<�Rfp'����,]i���dZ�#:9�( B��x $_�=�6Holu��5�~Sy��AZ�J�soSb2�O!���p_�z�;{��l�]~PK }�D[���� � [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 }�D[����' ' _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="R9bb0a0ce81c34ff7" /></Relationships>PK }�D[�i�� n xl/worksheets/sheet1.xml � (� ���s�0������$��Q;���l�����j,L�8���F���Z4���䛏#���l�}��H�b�C�|O-&z�.ކ������h���{�(Uz_g��O�ry��$QY\z���L�Y\���-ԳY:Q�z��Ԣ1B,��<.�VE�.[�+��e��i�B6ߖ��t���T�t��j6�/���^8T�T�����9�?��7wӡ�*6���j�ܛ�Y������V�oIiL�*�Dϋ���ҍu��ş��:���Y� b�QJ�.��MVE������V�k=���HS@��ZNvr EG�u��Ѷm�XPN)f�H�Q��Z=%�9��@�Y�g'��ko���E@%���zQ�ʼn��Z'�}Y@̆q� �pX�� �f�K�W �$C<�G<�&k�O<=41�6g��qb�$L�G*4����7��6saڠ .�ThBl�\3Y��4�~R�p;3�s��h�뵗W�M����,�j,�IS���1B��c����>]�O�.q�'H���'h����K�� �%n��w}Bt��>!��/�c���r�сX�>9��gb��@,g_HkmhR��n���"��Kb�}� �X�ߣ�$4��Od�ìx}���q4o%�v��%��˱��{bU��@,����Gb��ɁX)yv ���@�L�D�Y�FZb^�T>ֺTy5�v/���PK }�D[_rM� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞��Դ6lK/0q�I�Ķl��Xp$��U$H%l����I3�����2�r~2��4�HK�Ozh��]��fO3�8���zW�oa�>p��H��Xұ��[0�� ܢ<�@<��ǹk&;�-��h��$=yZH�?��ո�����B?%�/!M"�S��>���l�,K�s`�fj>�g�^��J�Ti��2�H���n+3���9�x�Ӻ�R�z�oTSw��(:uQ�W��PK }�D[Ѓ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 }�D[2g(z xl/sharedStrings.xml � (� ��[O�0��J��\Z�RP�]��\�Zi�=P�b;�T��cP����������ѣn�-8T��l�,#�T�f�կt�$n$o��� �,9j*DJ��`�6D�a�����'��iN��r�p� �m>-�y��2,�7T�������U����9�`H�+pUNM�?�!9��S�)B}�[!�k!�j;�pۍ�7`d�ױ ?�P�aE�}×w�@�G�#}5t�����6ꊬU/���\vง�c���\l�)? ��N��?!�Þ���\�i)'2�R�X@!f���L����Z���*&��O�w�9����ѐvqK۶���D�[!����n�ڛFx�x���ϋ����%��?���yPK- }�D[�W�� 5 xl/workbook.xmlPK- }�D[���� � [Content_Types].xmlPK- }�D[����' ' V _rels/.relsPK- }�D[�i�� n � xl/worksheets/sheet1.xmlPK- }�D[_rM� P � xl/_rels/workbook.xml.relsPK- }�D[Ѓc'2 E xl/styles.xmlPK- }�D[2g(z � xl/sharedStrings.xmlPK � U
application/vnd.ms-excel
Sample:
PK }�D[����� 5 xl/workbook.xml � (� ����0D�&�C���P��x��}��4Ж�5���H�yۙ�};�l��4f 5jW؊��Oc��Q�;� u� c� �!d��i� �g ��8��F�^N���Xn����W��i}<R.�ge0���I�b��2������m�%ѹu=Sb�;�fɅ�9OE�ҝ��J����PK }�D[���� � [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 }�D[�ɱ�' ' _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="R909601b0fa19467f" /></Relationships>PK }�D[�i�� n xl/worksheets/sheet1.xml � (� ���s�0������$��Q;���l�����j,L�8���F���Z4���䛏#���l�}��H�b�C�|O-&z�.ކ������h���{�(Uz_g��O�ry��$QY\z���L�Y\���-ԳY:Q�z��Ԣ1B,��<.�VE�.[�+��e��i�B6ߖ��t���T�t��j6�/���^8T�T�����9�?��7wӡ�*6���j�ܛ�Y������V�oIiL�*�Dϋ���ҍu��ş��:���Y� b�QJ�.��MVE������V�k=���HS@��ZNvr EG�u��Ѷm�XPN)f�H�Q��Z=%�9��@�Y�g'��ko���E@%���zQ�ʼn��Z'�}Y@̆q� �pX�� �f�K�W �$C<�G<�&k�O<=41�6g��qb�$L�G*4����7��6saڠ .�ThBl�\3Y��4�~R�p;3�s��h�뵗W�M����,�j,�IS���1B��c����>]�O�.q�'H���'h����K�� �%n��w}Bt��>!��/�c���r�сX�>9��gb��@,g_HkmhR��n���"��Kb�}� �X�ߣ�$4��Od�ìx}���q4o%�v��%��˱��{bU��@,����Gb��ɁX)yv ���@�L�D�Y�FZb^�T>ֺTy5�v/���PK }�D[yt�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�M�O��ݰa[z�'Q۲]�gc���V� �X��j4��'�|�l�o�D^ЇњV�FZ5���s� �w�N"��0�.��bBC�nCi��"d֡Im�,bJ}O��'�#���_2�I���!Z�G��V�g4�0}����(|����R�װ�ȓj���Uް�Ѣf\W��Z�� ï�w��)D]�]�9r�e�w��G�}���iY^���R�Ъ�%���j��/v_PK }�D[Ѓ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 }�D[2g(z xl/sharedStrings.xml � (� ��[O�0��J��\Z�RP�]��\�Zi�=P�b;�T��cP����������ѣn�-8T��l�,#�T�f�կt�$n$o��� �,9j*DJ��`�6D�a�����'��iN��r�p� �m>-�y��2,�7T�������U����9�`H�+pUNM�?�!9��S�)B}�[!�k!�j;�pۍ�7`d�ױ ?�P�aE�}×w�@�G�#}5t�����6ꊬU/���\vง�c���\l�)? ��N��?!�Þ���\�i)'2�R�X@!f���L����Z���*&��O�w�9����ѐvqK۶���D�[!����n�ڛFx�x���ϋ����%��?���yPK- }�D[����� 5 xl/workbook.xmlPK- }�D[���� � � [Content_Types].xmlPK- }�D[�ɱ�' ' U _rels/.relsPK- }�D[�i�� n � xl/worksheets/sheet1.xmlPK- }�D[yt�� P � xl/_rels/workbook.xml.relsPK- }�D[Ѓc'2 E xl/styles.xmlPK- }�D[2g(z � xl/sharedStrings.xmlPK � U