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": "npgT95EicUuJ8ebX+KXoWw==", "identifierGuid": "f713989e-2291-4b71-89f1-e6d7f8a5e85b", "priority": 2, "createdUtc": "2025-08-02T23:12:20.794895", "receivedUtc": "2025-08-02T23:12:20.794895", "rsvpUtc": "2025-08-02T23:12:20.794895", "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": [ "1949aa99-34ec-4e83-9bab-8dba105f3e7d", "476d53ae-e86a-4c58-abcf-2148cff7f955" ], "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-08-02T23:12:20.794895+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>npgT95EicUuJ8ebX+KXoWw==</Identifier> <IdentifierGuid>f713989e-2291-4b71-89f1-e6d7f8a5e85b</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>1949aa99-34ec-4e83-9bab-8dba105f3e7d</d2p1:guid> <d2p1:guid>476d53ae-e86a-4c58-abcf-2148cff7f955</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-08-02T23:12:20.794895+00:00</ReceivedUtc> <RsvpUtc>2025-08-02T23:12:20.794895+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:
"b7d55cbd-aeb4-4187-a533-914a1389ad14"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">b7d55cbd-aeb4-4187-a533-914a1389ad14</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK ��[q�H�� 5 xl/workbook.xml � (� ����0��&�C����8q���{)[�@����[J ��mgv�۩g����}�dB�,ct!�K�,���v�z�b��E��Cg�[���L�x�XT��\�+�Vp�$@�ӊ�L��K���9d����b"���o�ΰ�"+d��w,2��s\`�+���%��E�����V��w�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="R49a3aaf781134a8e" /></Relationships>PK ��[��n@% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%�6��T��j�M;lg�85�Ȑ��? �4i� [~~��T����4ښ盌3�-v�^k>���䧦Z�nNx�������(�k�68� ��HR� �{���ɀ�b�e{A0H��ң�+���H �d�+�����t`��A_�3�T ��aq�b��D��䥫y������_�u��i�o�<��*6T���nft�gF�ӻ�Ϋ�?�����}^�e�嬝�G�W�b�I�g�eS.�R9��(��� �¼s�Ub�������_�-]=PR����PK ��[7~�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�N�I��ݰa[z��Q;�]�gc���V���X��j4��'�|���o�D^Ї��x���U����)����'�D0�HZ��㲢4(���[Ц�v~�1�~��TG9 -���f��y���֣�G�N3����:1�K?`���%�"Q�<��j�f��\��z3���_��<�W�E�˪���7�1�c�}�t3��T�D���P���E�^���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 ��[�� � xl/sharedStrings.xml � (� 5�An�0E�b��1.А�8�H=A{�O�%<������]t��������V��]b��E<��1����@IA�f�~H@ݼ)�NYFXJٮ�ȼPB9卸&�yOX*�#�Nd!*i5/M�jF5�KՂ:8~t��*��?�C��S�HS�;;�5�m�/�C��s�xg�����PK- ��[q�H�� 5 xl/workbook.xmlPK- ��[���� � � [Content_Types].xmlPK- ��[�ٶ' ' U _rels/.relsPK- ��[��n@% � � xl/worksheets/sheet1.xmlPK- ��[7~�� P 8 xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E ~ xl/styles.xmlPK- ��[�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK ��[���~� 5 xl/workbook.xml � (� ����0��&�C��@��x�པ�m�?ik��-%�x�3;���q�ј��Y��uX�`B<���:�q��(ݓ�%����H�eq0� ��BZ�7�?,o����� ��Ը?�j�f �O2{��Dd��T�`�ERHSh�%�6u8��52����ȮuVB^�}�Z���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 ��[?�H ' ' _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="Re79165da9e6f41d8" /></Relationships>PK ��[��n@% � xl/worksheets/sheet1.xml � (� �Q�n� ��}%�6��T��j�M;lg�85�Ȑ��? �4i� [~~��T����4ښ盌3�-v�^k>���䧦Z�nNx�������(�k�68� ��HR� �{���ɀ�b�e{A0H��ң�+���H �d�+�����t`��A_�3�T ��aq�b��D��䥫y������_�u��i�o�<��*6T���nft�gF�ӻ�Ϋ�?�����}^�e�嬝�G�W�b�I�g�eS.�R9��(��� �¼s�Ub�������_�-]=PR����PK ��[�� � P xl/_rels/workbook.xml.rels � (� ��Kn� @��f_c;��*$�n�Ms�c��m��E��+�RK�.��j�<=��|�Xoߖ����5���F�a2#�STw=l7��"���'Hzb�{�4H���uh�DY���J?R'�Q�H�l��p�$�����R��G+O����Z1�?b��� ��"Q�< vU��l��a��7S�<c����3YD)�Q۰��TF��s��s�����5���I%�{���E�^���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 ��[�� � xl/sharedStrings.xml � (� 5�An�0E�b��1.А�8�H=A{�O�%<������]t��������V��]b��E<��1����@IA�f�~H@ݼ)�NYFXJٮ�ȼPB9卸&�yOX*�#�Nd!*i5/M�jF5�KՂ:8~t��*��?�C��S�HS�;;�5�m�/�C��s�xg�����PK- ��[���~� 5 xl/workbook.xmlPK- ��[���� � � [Content_Types].xmlPK- ��[?�H ' ' U _rels/.relsPK- ��[��n@% � � xl/worksheets/sheet1.xmlPK- ��[�� � P 8 xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E | xl/styles.xmlPK- ��[�� � � xl/sharedStrings.xmlPK � �