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
Message| Name | 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": "/DmxDGmYGkq9IM+L5rDTWw==",
"identifierGuid": "0cb139fc-9869-4a1a-bd20-cf8be6b0d35b",
"priority": 2,
"createdUtc": "2026-04-03T06:15:09.3185545",
"receivedUtc": "2026-04-03T06:15:09.3185545",
"rsvpUtc": "2026-04-03T06:15:09.3185545",
"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": [
"80ed527c-e6df-4a9a-9e86-29f5a287a564",
"6cdd1f8b-35ff-459f-a737-b9b85113f828"
],
"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>2026-04-03T06:15:09.3185545+00:00</CreatedUtc>
<Document>sample string 6</Document>
<DocumentObject />
<DocumentType>sample string 7</DocumentType>
<External>true</External>
<Identifier>/DmxDGmYGkq9IM+L5rDTWw==</Identifier>
<IdentifierGuid>0cb139fc-9869-4a1a-bd20-cf8be6b0d35b</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>80ed527c-e6df-4a9a-9e86-29f5a287a564</d2p1:guid>
<d2p1:guid>6cdd1f8b-35ff-459f-a737-b9b85113f828</d2p1:guid>
</Operators>
<Priority>2</Priority>
<ReceivedUtc>2026-04-03T06:15:09.3185545+00:00</ReceivedUtc>
<RsvpUtc>2026-04-03T06:15:09.3185545+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 �1�\�� 5 xl/workbook.xml � (� ����0��&�C���4�p��Ճ�J�@����[J ��mgv�ۡ�q�Ә}Ԥ}�,B�5!���?:��Q�1� {�L�V�)��"&��^H��J���ƽ jZQ�I���!�4{H�}����.&"k���h��I!�4�c�a��op���e�</�ȡ,*����;{�Q��n�PK �1�\���� � [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
�1�\���' ' _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="R8ed1d85f8794452d" /></Relationships>PK �1�\voO� y
xl/worksheets/sheet1.xml � (� ��Y��0��
��@��R�z��mf��
�B,���D���n_4T�sss<�bx��.�O���F>��l�gI�>�W������õ�?�X��3xV���r��4ViTz�2�7�y��1�|�LՕ��R��!���ZD�9���e�o�}�V��U4�ZH�Ri�d�x8KL�M�^��#�ސ��a�IԺ�[{�����c�p7��b�<�ͽ��G�E�[�oU���$Zi�zQT�^�l��4����ɬ��
�aFr�}o�*J�����*[=��h��<�\R)f@��r\��N.H C���:Ҷ�! 5�2��<������g����絞�zp
�D2!8:��^��7Y�d{.�9P�F�C����9�%�W�
�$��#��M� ���a7��� 1�M����
M� 9��M�`�=b��0m �G*4�l�\B�̈́��#��A���vvT��**��0�k/��M����,�j<��S�9�9��s����>��e�@]�O�.q�'H��� �%n���}�w��>!��}��]���e��\}r ������ŁXƾ:��7�Z�T���h���r�Xv_6�+V�{�AH�h
���\�|�q�o!��լ���/GVP��U���XF=:+(O�
ʳ����@����b�v��-ܛj�ygS�D�R���۽G��PK �1�\���j� P xl/_rels/workbook.xml.rels � (� ��Kn�0��b;q^$QE`æ[���C$vd�g�G�jQ�
Rݰ���'�|����ido�n0��$��AK���t��SE��z�Q�0��av,�hWS���̹�=&�"3C�Nk�$|Hm�g!��O��vɠ{&;\g��h�v��y���`~6��z�;����Sr��(P�����*ɐ&��U����������;_�T���*�U���Ceza�^�
�^:-�5�M��D.PV�Jӛ����PK �1�\Ѓ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 �1�\<gGfy xl/sharedStrings.xml � (� ��[O�0��J��\�B�EI�]��M�>!${J����T��cB���������ᳮ�-8T�l�d,#�T�`��x�"$n$����u�,:,sD���`�6D�A�����'k�4't�)6��
�:g�4�\ �*�؇�F=���|�*s*�$Rk.O���W5$���!�v�:E]�/|+rE"$7 @m�n�����u$�3TO�h�o����v�]��k d� ��u�+�pP��W��=�9V}2�;$��qGpw�LT��|-��l:����Ǖg�X�*�V���W��nj���*F{;���;�� �ҵ�!��-l]���br
�ɹBzݽ�834��5q��ꯋ�+�c��[�'�q�PK- �1�\�� 5 xl/workbook.xmlPK- �1�\���� � � [Content_Types].xmlPK-
�1�\���' ' U _rels/.relsPK- �1�\voO� y
� xl/worksheets/sheet1.xmlPK- �1�\���j� P � xl/_rels/workbook.xml.relsPK- �1�\Ѓc'2 E
xl/styles.xmlPK- �1�\<gGfy � xl/sharedStrings.xmlPK � G
application/vnd.ms-excel
Sample:
PK �1�\%7�`� 5 xl/workbook.xml � (� ����0D�&�C��H�p��Ճ��������Ϸ@ ��mgv�����ù������T�8V��N��pr#ڴ���I�'sR�[
���,+���v6(=���a��#�A!F3�(���x D������dlug��5�~Sb���"ִ��,ε��_�4܊�,Q�9�_8��;L��w�PK �1�\���� � [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
�1�\�tG' ' _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="R1458ea8410154ee1" /></Relationships>PK �1�\voO� y
xl/worksheets/sheet1.xml � (� ��Y��0��
��@��R�z��mf��
�B,���D���n_4T�sss<�bx��.�O���F>��l�gI�>�W������õ�?�X��3xV���r��4ViTz�2�7�y��1�|�LՕ��R��!���ZD�9���e�o�}�V��U4�ZH�Ri�d�x8KL�M�^��#�ސ��a�IԺ�[{�����c�p7��b�<�ͽ��G�E�[�oU���$Zi�zQT�^�l��4����ɬ��
�aFr�}o�*J�����*[=��h��<�\R)f@��r\��N.H C���:Ҷ�! 5�2��<������g����絞�zp
�D2!8:��^��7Y�d{.�9P�F�C����9�%�W�
�$��#��M� ���a7��� 1�M����
M� 9��M�`�=b��0m �G*4�l�\B�̈́��#��A���vvT��**��0�k/��M����,�j<��S�9�9��s����>��e�@]�O�.q�'H��� �%n���}�w��>!��}��]���e��\}r ������ŁXƾ:��7�Z�T���h���r�Xv_6�+V�{�AH�h
���\�|�q�o!��լ���/GVP��U���XF=:+(O�
ʳ����@����b�v��-ܛj�ygS�D�R���۽G��PK �1�\���� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞81n�TM�a�m��xGM��v=�����ĂMW��==i���c�}v&zg(��֩�v
��~�`�Y�i��&���Ҋ
���54b��D6u��#Ɣ��O��#.��~[&;\&��iݷ����H6����!���;�
����"KT`;����뚴$%J������B�~���LQ-
��x)
��*cГz�>]z�4/���#�Х�J����o�b�PK �1�\Ѓ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 �1�\<gGfy xl/sharedStrings.xml � (� ��[O�0��J��\�B�EI�]��M�>!${J����T��cB���������ᳮ�-8T�l�d,#�T�`��x�"$n$����u�,:,sD���`�6D�A�����'k�4't�)6��
�:g�4�\ �*�؇�F=���|�*s*�$Rk.O���W5$���!�v�:E]�/|+rE"$7 @m�n�����u$�3TO�h�o����v�]��k d� ��u�+�pP��W��=�9V}2�;$��qGpw�LT��|-��l:����Ǖg�X�*�V���W��nj���*F{;���;�� �ҵ�!��-l]���br
�ɹBzݽ�834��5q��ꯋ�+�c��[�'�q�PK- �1�\%7�`� 5 xl/workbook.xmlPK- �1�\���� � � [Content_Types].xmlPK-
�1�\�tG' ' U _rels/.relsPK- �1�\voO� y
� xl/worksheets/sheet1.xmlPK- �1�\���� P � xl/_rels/workbook.xml.relsPK- �1�\Ѓc'2 E
xl/styles.xmlPK- �1�\<gGfy � xl/sharedStrings.xmlPK � H