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": "pvmfa8LdKkuNgoK7QmS+1Q==", "identifierGuid": "6b9ff9a6-ddc2-4b2a-8d82-82bb4264bed5", "priority": 2, "createdUtc": "2025-10-04T23:56:35.5660437", "receivedUtc": "2025-10-04T23:56:35.5660437", "rsvpUtc": "2025-10-04T23:56:35.5660437", "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": [ "6cbed887-1cd0-4039-8136-10290f17db4c", "e1db5b3d-f05a-412c-9fc6-1abe170a73a7" ], "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:56:35.5660437+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>pvmfa8LdKkuNgoK7QmS+1Q==</Identifier> <IdentifierGuid>6b9ff9a6-ddc2-4b2a-8d82-82bb4264bed5</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>6cbed887-1cd0-4039-8136-10290f17db4c</d2p1:guid> <d2p1:guid>e1db5b3d-f05a-412c-9fc6-1abe170a73a7</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-10-04T23:56:35.5660437+00:00</ReceivedUtc> <RsvpUtc>2025-10-04T23:56:35.5660437+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:
"7e224cbb-2410-4eb1-b9ef-fc5aeb110c73"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">7e224cbb-2410-4eb1-b9ef-fc5aeb110c73</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK �D[[��o� 5 xl/workbook.xml � (� ���� D�M��(�M�z��k�S] QX4��Mz�mgv���3��8���l�|CU��b,� �t`��DoD\�1�R��a�6`#�8/��ID�6(��h���� �� ��6����|"�^�=4�!����&a[����;.�"Vhh'��$9���WJ|���>}�ˢ,˼ȹ��`����/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="R2cf8c8f72f124f9f" /></Relationships>PK �D[�!k% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%i�&��T��j�M;lg�85�Ȑ��? �4i� [~~��Tǻ��4ښ盌3�-v�^k>����ǦZ�nNx������� �k�68� ��HR� �{���ɀ�b�e{A0H��ң�+���H �d�+�����t`��A_�SΙh��|װ�_1�c|"�b���<KX�|Iʯ�:��4�7\�A_�zJ=-.���7Ό��wѝW5��"����v�yYr�NΣ�X˫K��$ͳ��F��c�q�iwa�*1��p���گ�.�()��\�PK �D[���1� P xl/_rels/workbook.xml.rels � (� ��An� E����`����M6ݦ��c�Hۜ���W(J��H]t��?��F����z�6O�C��i]qJ�)�G7���]G���'H�F��I~�bOmJ�cQY�!V~A�;ƇR.��PG�5��,�z�$���!zcF�;�N3�����p�1Qr�0`��O�娫L��Q�t��j�l���������b:O���B�u'����+#@�Me,�O)�M�Ne\�a��$W`�Xu�Ʈ���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[(�F�� � xl/sharedStrings.xml � (� 5�An� E��fO��۴&�H=As ��1�\�8jn���������//��B=4 )�1ѭ��Ϸ��hK!������:%�aYO�p�1>��&S�r�����ayF������C"P��$Uj���埫 y'��m��a�m�X�����'=��P�����xg^}S_�'PK- �D[[��o� 5 xl/workbook.xmlPK- �D[���� � � [Content_Types].xmlPK- �D[��� ' ' U _rels/.relsPK- �D[�!k% � � xl/worksheets/sheet1.xmlPK- �D[���1� P 8 xl/_rels/workbook.xml.relsPK- �D[Ѓc'2 E ~ xl/styles.xmlPK- �D[(�F�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK �D[��>� 5 xl/workbook.xml � (� ����0D�&�C����DR8q���� [i�-ik��H�yۙ�};b��Zۓ��/\I�Ƃ1�t����f�I�4�Y��R�kۼ5���$��� AY�;5z���a��!��CzXQ����@�X�=N>����.&ak���D��QKZC J�skK�R� 5�\�y��|�.)6tg�0����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="R50b31cfee1404d1a" /></Relationships>PK �D[�!k% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%i�&��T��j�M;lg�85�Ȑ��? �4i� [~~��Tǻ��4ښ盌3�-v�^k>����ǦZ�nNx������� �k�68� ��HR� �{���ɀ�b�e{A0H��ң�+���H �d�+�����t`��A_�SΙh��|װ�_1�c|"�b���<KX�|Iʯ�:��4�7\�A_�zJ=-.���7Ό��wѝW5��"����v�yYr�NΣ�X˫K��$ͳ��F��c�q�iwa�*1��p���گ�.�()��\�PK �D[T��k� P xl/_rels/workbook.xml.rels � (� ��An� E��f_�]L�(N6�d���, is�.z�^�(�Z"u�MVh���������<�3:?Z�@�1 h��F�7p ����f��I�x���I|b|CˊR�����&v�u��t=]�:�i���.e�-�.��h�>[u�ф?��պ���t=�~"O�G�E*�]���ԢD��X<G��M͇˄���Ndt[�����B�kV�Uf�����S�4N�ĺR���J����U�����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[(�F�� � xl/sharedStrings.xml � (� 5�An� E��fO��۴&�H=As ��1�\�8jn���������//��B=4 )�1ѭ��Ϸ��hK!������:%�aYO�p�1>��&S�r�����ayF������C"P��$Uj���埫 y'��m��a�m�X�����'=��P�����xg^}S_�'PK- �D[��>� 5 xl/workbook.xmlPK- �D[���� � � [Content_Types].xmlPK- �D[��*' ' U _rels/.relsPK- �D[�!k% � � xl/worksheets/sheet1.xmlPK- �D[T��k� P 8 xl/_rels/workbook.xml.relsPK- �D[Ѓc'2 E xl/styles.xmlPK- �D[(�F�� � � xl/sharedStrings.xmlPK � �