POST api/messages
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": "LKbIJoDh1kaFdmHXGWW4iQ==", "identifierGuid": "26c8a62c-e180-46d6-8576-61d71965b889", "priority": 2, "createdUtc": "2025-06-14T06:13:02.8714319", "receivedUtc": "2025-06-14T06:13:02.8714319", "rsvpUtc": "2025-06-14T06:13:02.8714319", "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": [ "724f33a4-05e8-4faa-a4b4-c855f92dff2f", "091d795f-ee02-4e5a-b526-8bfd9d700b2b" ], "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:13:02.8714319+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>LKbIJoDh1kaFdmHXGWW4iQ==</Identifier> <IdentifierGuid>26c8a62c-e180-46d6-8576-61d71965b889</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>724f33a4-05e8-4faa-a4b4-c855f92dff2f</d2p1:guid> <d2p1:guid>091d795f-ee02-4e5a-b526-8bfd9d700b2b</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-06-14T06:13:02.8714319+00:00</ReceivedUtc> <RsvpUtc>2025-06-14T06:13:02.8714319+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:
"9419149b-d95b-4b41-8142-842d8358a6b4"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">9419149b-d95b-4b41-8142-842d8358a6b4</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK �1�Z�T�� 5 xl/workbook.xml � (� ����0D�&�C��@�FR8q����[i�-ik��-H�yۙ�};b������G�箠]cΘo:��OvDw�: !J�bVJ�`e��FX�$�p����=]i����Z�!=�( ���x D�͞ '��hlug��5�~Sb���"4�� �,ν-hJ��U<�5O�z��P����a�m��/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�,C!' ' _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="Rb3197f433ecd4a4f" /></Relationships>PK �1�Z� �y$ � xl/worksheets/sheet1.xml � (� �Q�N�0��(w������Ӥi�� �кK�&����瓤!q�Ė��{v���lrmͷ��3�-v�^j>����jA�:�Y�[���+�ǽ�U`���6�z$#}H�"��u'l'<�� }�rJ���l��r#��3�TFj˛�Ӂ=�g}͏[�DS%仆���Y������Y?�sR~%�A/�������|�P�zZ\���qo�yK�;�j^�6y���bW>�9g��<�����+K�<I/��pa�ʁ<Fq��mƝ��s� '����*, �聒���5_PK �1�Zhm�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8i&�VM�aö��3��&vd�@�Ƃ#q�"A*�`��h~OO��|���ߦ����5 dI ����`��A=�m4�'�f��� �� �^j��O�L&v�u�1u=��<���*MK��e��e���R��G+�����Zw�( ; �Sh���5dI�{�8�J��Q�F�P�0~75.#�_��|!�!ֲ.�ʩ�b�w���Q�\���iY^��-�%�U!�������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�JJ�� � xl/sharedStrings.xml � (� 5�An� E��fO0.�p�ɢRO� �i�d׃���!�,���z�]��*~q�Th}�@ �%&��p����@1��p�dWhS��Z�w�x^0>� �%�eϡ6�C���U�]wQ9$1��jӂ8(����&H�U?=h3L2�I��hi��5}�og.�q�z��}�^�PK- �1�Z�T�� 5 xl/workbook.xmlPK- �1�Z���� � � [Content_Types].xmlPK- �1�Z�,C!' ' U _rels/.relsPK- �1�Z� �y$ � � xl/worksheets/sheet1.xmlPK- �1�Zhm�� P 7 xl/_rels/workbook.xml.relsPK- �1�ZЃc'2 E } xl/styles.xmlPK- �1�Z�JJ�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK �1�Zʐ� 5 xl/workbook.xml � (� ����0�w$�!��*���SVv�qI��GIPy|��Vbc�ϟO�.�s=����"�\����*2OΓ�v��$�\��j ��,�B��v6*�#_i����2*�d�eP[^����S�9[��d���7%�~�(f�P�kL����e�Ϝ�BO�C�HM�e(�l���a���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�ZP�X' ' _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="R47dc786b89c84708" /></Relationships>PK �1�Z� �y$ � xl/worksheets/sheet1.xml � (� �Q�N�0��(w������Ӥi�� �кK�&����瓤!q�Ė��{v���lrmͷ��3�-v�^j>����jA�:�Y�[���+�ǽ�U`���6�z$#}H�"��u'l'<�� }�rJ���l��r#��3�TFj˛�Ӂ=�g}͏[�DS%仆���Y������Y?�sR~%�A/�������|�P�zZ\���qo�yK�;�j^�6y���bW>�9g��<�����+K�<I/��pa�ʁ<Fq��mƝ��s� '����*, �聒���5_PK �1�Z�V�O� P xl/_rels/workbook.xml.rels � (� ��An� E��f_�S�I'�n�Ms��b��m��E��+�R�H]t��?��4����f�6��c�o���:���-������n�8�\n$7̉�'>��r�(M��Rf�cC�T.e���Q�HW� ��f��y������ǠO�����xL19��cn�'J�r�U�y2-� G��c�)���Л��|1�z}���=�u��k�-67�q*�yαlz鴌jB�2����V\��տ�~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�JJ�� � xl/sharedStrings.xml � (� 5�An� E��fO0.�p�ɢRO� �i�d׃���!�,���z�]��*~q�Th}�@ �%&��p����@1��p�dWhS��Z�w�x^0>� �%�eϡ6�C���U�]wQ9$1��jӂ8(����&H�U?=h3L2�I��hi��5}�og.�q�z��}�^�PK- �1�Zʐ� 5 xl/workbook.xmlPK- �1�Z���� � � [Content_Types].xmlPK- �1�ZP�X' ' T _rels/.relsPK- �1�Z� �y$ � � xl/worksheets/sheet1.xmlPK- �1�Z�V�O� P 6 xl/_rels/workbook.xml.relsPK- �1�ZЃc'2 E | xl/styles.xmlPK- �1�Z�JJ�� � � xl/sharedStrings.xmlPK � �