POST api/message
Create or update a message
Request Information
URI Parameters
None.
Body Parameters
Message to save
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. |
Request Formats
application/json, text/json
Sample:
{ "identifier": "HHFAo0tWoEyGWPqUIwrudQ==", "identifierGuid": "a340711c-564b-4ca0-8658-fa94230aee75", "priority": 2, "createdUtc": "2025-06-14T06:12:08.1593425", "receivedUtc": "2025-06-14T06:12:08.1593425", "rsvpUtc": "2025-06-14T06:12:08.1593425", "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": [ "1633c848-e2d2-40ba-af81-3c3cabfa5109", "a3b3d006-4942-458e-b385-fb42977c926c" ], "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:12:08.1593425+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>HHFAo0tWoEyGWPqUIwrudQ==</Identifier> <IdentifierGuid>a340711c-564b-4ca0-8658-fa94230aee75</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>1633c848-e2d2-40ba-af81-3c3cabfa5109</d2p1:guid> <d2p1:guid>a3b3d006-4942-458e-b385-fb42977c926c</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-06-14T06:12:08.1593425+00:00</ReceivedUtc> <RsvpUtc>2025-06-14T06:12:08.1593425+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/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Saved message identifier
globally unique identifierResponse Formats
application/json, text/json
Sample:
"056debcb-36e5-42f2-acfe-2d64505639ea"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">056debcb-36e5-42f2-acfe-2d64505639ea</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK �1�Z� }�� 5 xl/workbook.xml � (� ����0��J}�(�PT@B��ҵCwL� ?JR��o�[7�����E۩�z"9+Wښ�ޛ�1�G��.ڠ �A[ >H�bz�V�D�Y�$9�8�Z�QG7�?,g,B�FD/� %A(ڜO�Tk����E���j���o����"*�@bM[�@It�}M���R��i^`Wt���e==��b���PK �1�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 �1�Z�V�P' ' _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="Rf6508588f0474ce1" /></Relationships>PK �1�ZS��B$ � xl/worksheets/sheet1.xml � (� �Q�n� ��}%͔4��T��j�M;lg�85����? �4i� [~~��ԧ���k� ��2��v�k{m�L�C�Om���y@,��?��+��(���w8� ���Rw8��3v�K"ϲR8%)������.?9�}�`ƍ�Hmy[�:�G�����=g���]���,��x��K��,a��%)�:�� ��p}}U6T��G�nft�gF�ӻ�T��C��e�yY���=���ʛK��$ͳ$��W�R9��(��� �üK��b�������_�-�� ����s�PK �1�Z��%� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8�i��ݰa[z��Q;�]�gc���V� �X��j4��'�|�l�o�H^Ї���,�V:5ؾ�s�+��EL�s iņL��� N"dnF�:��IĔ���B�D���sN���Lr�����z����yB� �W�O� F G�{�-����"KT O���(y�]� �sV� ��Z��ï�w��ѼhT��L��5�����s���K�ey���^)�֜)���Fo�b�PK �1�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 �1�Z��)�� � xl/sharedStrings.xml � (� 5�An�0E�b��1%%�1�J9Az ��%<&�P%�����������ʋ���S�> (�Pb�� ߷�>�b��Rx#��eU���"�1f̞eE�d*[�R��0�n�#ψ��6Mo�O*���jA픞;~��*HΊk�>�=����N�ک�>L��؟� ��ֈ��o�+�PK- �1�Z� }�� 5 xl/workbook.xmlPK- �1�Z���� � � [Content_Types].xmlPK- �1�Z�V�P' ' U _rels/.relsPK- �1�ZS��B$ � � xl/worksheets/sheet1.xmlPK- �1�Z��%� P 7 xl/_rels/workbook.xml.relsPK- �1�ZЃc'2 E ~ xl/styles.xmlPK- �1�Z��)�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK �1�ZV pi� 5 xl/workbook.xml � (� ��;�0D�H���Ā�G�PѤM�ޘu��َ��c�@J�ngv���ٸ�3fD5i_�!؊�P̟�w�8�B��E��Ck�[��Ȳq0� ������X�:`� ��V�bR��x@�.͞f�d4�����"�)�`�ERH35nY`%���8��U2���r�s(��V?㝽�(�~7_PK �1�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 �1�Z��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="R599c12695f464fdd" /></Relationships>PK �1�ZS��B$ � xl/worksheets/sheet1.xml � (� �Q�n� ��}%͔4��T��j�M;lg�85����? �4i� [~~��ԧ���k� ��2��v�k{m�L�C�Om���y@,��?��+��(���w8� ���Rw8��3v�K"ϲR8%)������.?9�}�`ƍ�Hmy[�:�G�����=g���]���,��x��K��,a��%)�:�� ��p}}U6T��G�nft�gF�ӻ�T��C��e�yY���=���ʛK��$ͳ$��W�R9��(��� �üK��b�������_�-�� ����s�PK �1�Z�,��� P xl/_rels/workbook.xml.rels � (� ��MN�0F�b͞��)j� ��p�q5�#��l,8W�*�6]Y3c?=}������m��z�mAfZ���-���k`�Y�pR!ޠa\��'�ZBX8'=�(s�81��*���|Q��z�5�)��l^�?Dg̨���ӌ6���i@����Z�i�2�T`O]��;H�%��)QW����(�'�_��:��+#�ϡ�eQVX�TfP����S����T�p��eQ�(�E�_���PK �1�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 �1�Z��)�� � xl/sharedStrings.xml � (� 5�An�0E�b��1%%�1�J9Az ��%<&�P%�����������ʋ���S�> (�Pb�� ߷�>�b��Rx#��eU���"�1f̞eE�d*[�R��0�n�#ψ��6Mo�O*���jA픞;~��*HΊk�>�=����N�ک�>L��؟� ��ֈ��o�+�PK- �1�ZV pi� 5 xl/workbook.xmlPK- �1�Z���� � � [Content_Types].xmlPK- �1�Z��d�' ' U _rels/.relsPK- �1�ZS��B$ � � xl/worksheets/sheet1.xmlPK- �1�Z�,��� P 7 xl/_rels/workbook.xml.relsPK- �1�ZЃc'2 E } xl/styles.xmlPK- �1�Z��)�� � � xl/sharedStrings.xmlPK � �