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": "xmfWLJ0Ut0icrTqwwUUVlw==", "identifierGuid": "2cd667c6-149d-48b7-9cad-3ab0c1451597", "priority": 2, "createdUtc": "2025-10-04T23:56:33.9254613", "receivedUtc": "2025-10-04T23:56:33.9254613", "rsvpUtc": "2025-10-04T23:56:33.9254613", "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": [ "07cea94e-bb58-4366-a3b8-06938db2b946", "778284a8-2a1f-4ac2-94fb-b738bb633865" ], "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:33.9254613+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>xmfWLJ0Ut0icrTqwwUUVlw==</Identifier> <IdentifierGuid>2cd667c6-149d-48b7-9cad-3ab0c1451597</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>07cea94e-bb58-4366-a3b8-06938db2b946</d2p1:guid> <d2p1:guid>778284a8-2a1f-4ac2-94fb-b738bb633865</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-10-04T23:56:33.9254613+00:00</ReceivedUtc> <RsvpUtc>2025-10-04T23:56:33.9254613+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:
"8f0d3db4-7438-45d5-8b26-a91cfd5cf6bc"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8f0d3db4-7438-45d5-8b26-a91cfd5cf6bc</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK �D[U� 5 xl/workbook.xml � (� ����0��J}�(�P0�t���$�D�%���7�ԭ��|�|�b��3�����\C�lŘ�#*�cQ��`���{13�cg�[�,ϲs8C�F�QZO7�?,o��#bP�R 5m�'B��S�Ⓦ�^w5 �B�7U'�q�Ѡ���$9w��+%��qx�^�e^p�yYdC;���l��~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[� q' ' _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="R1dc5da401b6f4db0" /></Relationships>PK �D[��g�& � xl/worksheets/sheet1.xml � (� �QMo� �+��J�&뇒T��j�M;lg�85���?@�i�.; ���)Owӳ ��h+�^e��m���Z=?���� � ���*�����Q`�_� 6�:tFRH�U`���،,�M�= �� �<_�����ML�P�-��V��9�*���L�eB�k�����1>o1yi+�%���$�W�Z�����Ϡ�����`��͌�{���{zgݒ��v��7yq���ú�rΚ������M�<K�u�pf.�{��<>9 �>�;�Y)��N��_�U��"�K ??WPK �D[d���� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;��� �n��\�ؓ8"�-۴�l]�H�B-*� ���h~OO����Zo?�����5�A#�L�������G�DЃ$���A��V��q!�M�t�O"���� y=҂���9n�dv���Aⳕ� M�����F�@���9����<KT /��Nԡ*J���J&�0��#���o>�Y��)��|���b�P-<���ӥ�N��L�b�b����e٪��Fo�b�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[���ү � xl/sharedStrings.xml � (� 5�An�0E�b��1I���8�H=A{ c�Sf����]t��������W�ĝS�ΧR(1�c�Ϗw=�b��ZG�Aus�YT����lo�pX0{>� �&sٳ����� J^ͥiz�}"P�$U��u���� 9+n��x�S�_���.vz�.����0�.���g�_��W�PK- �D[U� 5 xl/workbook.xmlPK- �D[���� � � [Content_Types].xmlPK- �D[� q' ' U _rels/.relsPK- �D[��g�& � � xl/worksheets/sheet1.xmlPK- �D[d���� P 9 xl/_rels/workbook.xml.relsPK- �D[Ѓc'2 E � xl/styles.xmlPK- �D[���ү � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK �D[�~;�� 5 xl/workbook.xml � (� ����0D�&�C�� *N\�z��" �%m ~��o�vfg�N>k3�Z�#Ge3S�)c�6=J�'=��N �K�b��D��n��cq���Nhe{1Y���a�� ��Gtr\Q����@H�4{ �m����.&ak���� �/�" $�����L�Ʉu��W���s�ۄ�����w�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[�Oam' ' _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="Re917d9bf005b46b1" /></Relationships>PK �D[��g�& � xl/worksheets/sheet1.xml � (� �QMo� �+��J�&뇒T��j�M;lg�85���?@�i�.; ���)Owӳ ��h+�^e��m���Z=?���� � ���*�����Q`�_� 6�:tFRH�U`���،,�M�= �� �<_�����ML�P�-��V��9�*���L�eB�k�����1>o1yi+�%���$�W�Z�����Ϡ�����`��͌�{���{zgݒ��v��7yq���ú�rΚ������M�<K�u�pf.�{��<>9 �>�;�Y)��N��_�U��"�K ??WPK �D[�K��� P xl/_rels/workbook.xml.rels � (� ��Kn� ���f_��#��M6ݦ� ��X���6g�G��R�u�.�� �?��������4�:?X�B��@�+ӷpꩆ�vs���x��a�$>1�¼�������Ď�n�!���3'�#�Ӵ�nɀ{&9^g��*5�[q�Є?��պ�ȑ�C?���#K"ȳl�Љ��yӱ*g��}������w��)�Y�ի��X.��h�P�7�tZ��9UM%T�� ��J���ݿ�~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[���ү � xl/sharedStrings.xml � (� 5�An�0E�b��1I���8�H=A{ c�Sf����]t��������W�ĝS�ΧR(1�c�Ϗw=�b��ZG�Aus�YT����lo�pX0{>� �&sٳ����� J^ͥiz�}"P�$U��u���� 9+n��x�S�_���.vz�.����0�.���g�_��W�PK- �D[�~;�� 5 xl/workbook.xmlPK- �D[���� � [Content_Types].xmlPK- �D[�Oam' ' V _rels/.relsPK- �D[��g�& � � xl/worksheets/sheet1.xmlPK- �D[�K��� P : xl/_rels/workbook.xml.relsPK- �D[Ѓc'2 E � xl/styles.xmlPK- �D[���ү � � xl/sharedStrings.xmlPK � �