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": "XxakYsxaHkGhlhZUDrNiHA==", "identifierGuid": "62a4165f-5acc-411e-a196-16540eb3621c", "priority": 2, "createdUtc": "2025-08-02T23:12:21.9824439", "receivedUtc": "2025-08-02T23:12:21.9824439", "rsvpUtc": "2025-08-02T23:12:21.9824439", "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": [ "de56b3ee-2bed-459a-b5bf-9bc0ef99d313", "cb75f20f-d78c-4674-ab0f-e87c8d877857" ], "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:21.9824439+00:00</CreatedUtc> <Document>sample string 6</Document> <DocumentObject /> <DocumentType>sample string 7</DocumentType> <External>true</External> <Identifier>XxakYsxaHkGhlhZUDrNiHA==</Identifier> <IdentifierGuid>62a4165f-5acc-411e-a196-16540eb3621c</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>de56b3ee-2bed-459a-b5bf-9bc0ef99d313</d2p1:guid> <d2p1:guid>cb75f20f-d78c-4674-ab0f-e87c8d877857</d2p1:guid> </Operators> <Priority>2</Priority> <ReceivedUtc>2025-08-02T23:12:21.9824439+00:00</ReceivedUtc> <RsvpUtc>2025-08-02T23:12:21.9824439+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:
"a055ac3e-84ee-4e7f-9e0e-b673b5bb36db"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">a055ac3e-84ee-4e7f-9e0e-b673b5bb36db</guid>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK ��[��� 5 xl/workbook.xml � (� ���� D�&���m1 ����eb�0��m�ě���ٷ#&^�_�c��P��X3{��ɏ��N�`!e��+ez�|��������$�]�f�t��Êc@�Q#&;�(���x D������llug��5�~Sb���",6���,�U6��$�&7�_TQr��R��;L��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 ��[�k}' ' _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="R9bd1265c066a43ee" /></Relationships>PK ��[$}�% � xl/worksheets/sheet1.xml � (� �Q�N�0��(w�veLm'�i�� �кK�&����瓤!q�Ė��{v���lrm��M��;m/5�|��ǦZ��Nx������� �k�68� ��HR��{�� �ɀ�b�e� �RN����?\n$�]�`���HmySu:�G�����SΙh��|װ�_1�c|"^c���<KX�|Nʯ�:��4�7\�A_��O=-.���7Ό��wѝW5/��]�{(����E�Y;9��c-�.�J�4O�˦"\�r`�Q��%�A܅y�&��{� �o�k� [:#z����s�PK ��[��� P xl/_rels/workbook.xml.rels � (� ��Mn� F��f_�B�(N6�t��Ɗ Hۜ���W(j�Ƒ��&+4����ߟ_���4�7�a���<c@�H� �o��S ��z����FЃ$=1��[Q��I��:4����DL���(z�c��9n�dv��Uj��l�iB���Ǡ#���=���@�<KT /];�;^+�s��U� �aj!�GW�K=���lj�Բ>�UY.*����5����<��a�4�o���J�˜�Ϳ�� 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 ��[J�_�� � xl/sharedStrings.xml � (� 5�Kn�0D�"p�H�c�YY� �H6�(פ���UY>��O��WN�z��,(�����=ܿ>� K�1̅��_dPW�E�)q��r1�� s�]Y�j�(kRq}^V#O��g�amgrHj(IՂ�(}ox{s$��۶ahP����LJ>�E�c��n�Έw�o�+�PK- ��[��� 5 xl/workbook.xmlPK- ��[���� � � [Content_Types].xmlPK- ��[�k}' ' U _rels/.relsPK- ��[$}�% � � xl/worksheets/sheet1.xmlPK- ��[��� P 8 xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E � xl/styles.xmlPK- ��[J�_�� � � xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK ��[]V4m� 5 xl/workbook.xml � (� ����0��&�C�����N\�z�^�V�O�||K $���~;t2nx3����\��lE��zP��w�8�B��E����to:��x�#�h�K��B����}Ը��7�Btn��0�$��֝MD��M��.�B�)�q��(97^�#W�8�ˬ��g'��9������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 ��[�OR�' ' _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="R5b532c3b5d584d01" /></Relationships>PK ��[$}�% � xl/worksheets/sheet1.xml � (� �Q�N�0��(w�veLm'�i�� �кK�&����瓤!q�Ė��{v���lrm��M��;m/5�|��ǦZ��Nx������� �k�68� ��HR��{�� �ɀ�b�e� �RN����?\n$�]�`���HmySu:�G�����SΙh��|װ�_1�c|"^c���<KX�|Nʯ�:��4�7\�A_��O=-.���7Ό��wѝW5/��]�{(����E�Y;9��c-�.�J�4O�˦"\�r`�Q��%�A܅y�&��{� �o�k� [:#z����s�PK ��[s_�.� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�I�6EM�aö��=N�&�e�@�Ƃ#q,@�J,�t5��ӓf�_�6��ybO��hMe!���V�����M��fO�4���VL�`���r�@3��:2����1���ܡ<bO�b�}K&;���h�%�Yy���?����c�"���b?��?CY$*�{���-ծT��JՕj�x�(�z}噌x\��Z7X�(�2zRѧK�Ny9SӨ�Z�t��m�~���~ 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 ��[J�_�� � xl/sharedStrings.xml � (� 5�Kn�0D�"p�H�c�YY� �H6�(פ���UY>��O��WN�z��,(�����=ܿ>� K�1̅��_dPW�E�)q��r1�� s�]Y�j�(kRq}^V#O��g�amgrHj(IՂ�(}ox{s$��۶ahP����LJ>�E�c��n�Έw�o�+�PK- ��[]V4m� 5 xl/workbook.xmlPK- ��[���� � [Content_Types].xmlPK- ��[�OR�' ' V _rels/.relsPK- ��[$}�% � � xl/worksheets/sheet1.xmlPK- ��[s_�.� P 9 xl/_rels/workbook.xml.relsPK- ��[Ѓc'2 E ~ xl/styles.xmlPK- ��[J�_�� � � xl/sharedStrings.xmlPK � �