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": "p/dOx4tAnkm5Xwa/ED1ldA==",
"identifierGuid": "c74ef7a7-408b-499e-b95f-06bf103d6574",
"priority": 2,
"createdUtc": "2026-06-03T18:31:48.0927474",
"receivedUtc": "2026-06-03T18:31:48.0927474",
"rsvpUtc": "2026-06-03T18:31:48.0927474",
"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": [
"2e4d6300-c14f-4478-b66d-c1c9a7681552",
"1d5ac45f-dfd0-4104-999e-72f16a2fbf08"
],
"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-06-03T18:31:48.0927474+00:00</CreatedUtc>
<Document>sample string 6</Document>
<DocumentObject />
<DocumentType>sample string 7</DocumentType>
<External>true</External>
<Identifier>p/dOx4tAnkm5Xwa/ED1ldA==</Identifier>
<IdentifierGuid>c74ef7a7-408b-499e-b95f-06bf103d6574</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>2e4d6300-c14f-4478-b66d-c1c9a7681552</d2p1:guid>
<d2p1:guid>1d5ac45f-dfd0-4104-999e-72f16a2fbf08</d2p1:guid>
</Operators>
<Priority>2</Priority>
<ReceivedUtc>2026-06-03T18:31:48.0927474+00:00</ReceivedUtc>
<RsvpUtc>2026-06-03T18:31:48.0927474+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 ���\T�Bb� 5 xl/workbook.xml � (� ���� ��M��(jl��z��k�#.�(`��>~�Io����~;բ��i=����-M������^���6�:/͋h��V���HE7b`�Nhe1[���a�� �� �䴡$
7�B���)`�Azc����l!��
)*��-u������R��fI�]s]��,���Ud��|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="R8967d2813d6f49fe" /></Relationships>PK ���\:Y'|� z
xl/worksheets/sheet1.xml � (� ��Y��0��
��@�ZjWo�����3���Z�E��?A$���
�������}e�S:U�ȇ�=�O�,��G�������x�VŇN�,=��zP���,��0��Df��R�fo��,.�c���<��+5]e2/C
��Ks�Nҥ��վSK/Ϫ�ŶT��?�RS}ӽW���?��7�{�xX�R��{kos�J}l�f#Tl'�ᯅ7��x�(���LߓҘD*�T-t��e��:����{���Ĭ��Јb���L0ߛ�t����vSe�G���(�����G�>��E 1����Z�۾Q�&Dp
G�֓������ֳV�F �9C������&j�hϥAd�Q!�!hN��"�+pH8��F0>R� D?�=l�ۼ�(@�E�y�i�H�&x�z�&z��6�7m` 8G*4�t�L@�C<�M� �Q�p;<�Is��xX��WTۦ�fun���Of�h3�>�`~n�5q�'`����K\���K\� �%&}�t��>A��m�`]�O�.q�'D�xp8f���@,W��e��|}q ����r�́�ֆ&U�h�6Z�/�ܾp �ݗ
�����р18�����7���0��W�~YA�w V�b���@��<9+(��
ʋ����Ċ��Ad�po�%�M�JYTso�"9�PK ���\�X(� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�I�ĭ�vÆm�\{�DM��v���G�
XE�Tb�������4����ٽM#yAg[�3�rz�]�h춛=�2���s iņ��5�A�8ɐ�m��'S�;:Ku�҂���%n��p��?Dg̠�ѩ�6���ΟB����0��S
��,Q�<���)ر&_W\���Z��ï�w��)+��a:gȹ(�+�K��9�t�Ӳ�P���,/�F+��Z\���_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 ���\�VE�{ xl/sharedStrings.xml � (� ��[O�0��J��\ZJCQ�[v�r�Oh�u� 5��gR��A; ģ��3g4'���v`Q]�I���0���%[�~�G,B���P��E'U�H��j,ٖ�;NS[PӁv�1VqrG{�bg� զ�,���K�"azM%���^��=,_!����4�F�-R���Y��Y/k�^[i���ח��zM�'7 @����t��C�����+����}D?�WC>��H`5o���X�Q�����U�;8��x��V�����@p�ׇ"�A��<�eG�x�X@�Y6q6�4�젞�3߃\u-�ݳn� ��Ƨ��;��>^�>�>ni�^��3�`�H�H�����sM�` �߮���A�/�o_���S���'PK- ���\T�Bb� 5 xl/workbook.xmlPK- ���\���� � [Content_Types].xmlPK-
���\>-��' ' W _rels/.relsPK- ���\:Y'|� z
� xl/worksheets/sheet1.xmlPK- ���\�X(� P � xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
xl/styles.xmlPK- ���\�VE�{ � xl/sharedStrings.xmlPK � N
application/vnd.ms-excel
Sample:
PK ���\@{�� 5 xl/workbook.xml � (� ����0D�&�C��J,R8q����Ri�-ik��-H�yۙ�};b������G�箠]cΘ�j�';����:
!J�b�m���ʷFXr>��� AY�;5z���a��!4�CzXQ����@���=N~�����&ak�����/Eh,h(Y�{S�%.Wqxp.yƳ�:�� ҝ���~�_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
���\��r�' ' _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="R8e0efc83254b4322" /></Relationships>PK ���\:Y'|� z
xl/worksheets/sheet1.xml � (� ��Y��0��
��@�ZjWo�����3���Z�E��?A$���
�������}e�S:U�ȇ�=�O�,��G�������x�VŇN�,=��zP���,��0��Df��R�fo��,.�c���<��+5]e2/C
��Ks�Nҥ��վSK/Ϫ�ŶT��?�RS}ӽW���?��7�{�xX�R��{kos�J}l�f#Tl'�ᯅ7��x�(���LߓҘD*�T-t��e��:����{���Ĭ��Јb���L0ߛ�t����vSe�G���(�����G�>��E 1����Z�۾Q�&Dp
G�֓������ֳV�F �9C������&j�hϥAd�Q!�!hN��"�+pH8��F0>R� D?�=l�ۼ�(@�E�y�i�H�&x�z�&z��6�7m` 8G*4�t�L@�C<�M� �Q�p;<�Is��xX��WTۦ�fun���Of�h3�>�`~n�5q�'`����K\���K\� �%&}�t��>A��m�`]�O�.q�'D�xp8f���@,W��e��|}q ����r�́�ֆ&U�h�6Z�/�ܾp �ݗ
�����р18�����7���0��W�~YA�w V�b���@��<9+(��
ʋ����Ċ��Ad�po�%�M�JYTso�"9�PK ���\N�!�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8�선�ݰa[z��3N�&vd�@�Ƃ#q�"�+�`��h~OO��|���ޖ����5-Y����d�NA���n��ӌ!N�qZ=�+Ʒ0��>p��H�̮dbG[�`������2�+�R\3����V�IѣU��L��_�;��( ;�(��S���,R�=�-�T��M���DW0~35�3�_��<��]S*�kE-��ʌ�.^:uJˉZ 2'����yQ�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 ���\�VE�{ xl/sharedStrings.xml � (� ��[O�0��J��\ZJCQ�[v�r�Oh�u� 5��gR��A; ģ��3g4'���v`Q]�I���0���%[�~�G,B���P��E'U�H��j,ٖ�;NS[PӁv�1VqrG{�bg� զ�,���K�"azM%���^��=,_!����4�F�-R���Y��Y/k�^[i���ח��zM�'7 @����t��C�����+����}D?�WC>��H`5o���X�Q�����U�;8��x��V�����@p�ׇ"�A��<�eG�x�X@�Y6q6�4�젞�3߃\u-�ݳn� ��Ƨ��;��>^�>�>ni�^��3�`�H�H�����sM�` �߮���A�/�o_���S���'PK- ���\@{�� 5 xl/workbook.xmlPK- ���\���� � � [Content_Types].xmlPK-
���\��r�' ' U _rels/.relsPK- ���\:Y'|� z
� xl/worksheets/sheet1.xmlPK- ���\N�!�� P � xl/_rels/workbook.xml.relsPK- ���\Ѓc'2 E
xl/styles.xmlPK- ���\�VE�{ � xl/sharedStrings.xmlPK � J