GET https://api.d-tools.com/SI/Message/PublishedMessageStatus?messageId={messageId}
Get status of a published message.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
messageId |
Id of the message |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
MessageStatusName | Description | Type | Additional information |
---|---|---|---|
Id |
Id of Message |
globally unique identifier |
None. |
TypeId |
Type Id of the message. ProductCatalog = 1, Project = 11, UpdateProject = 12, NewProjectChangeOrderInfo = 13, UpdateClient = 21, ClientList = 22 |
byte |
None. |
StatusId |
Status Id of the message. Pending = 1, Imported = 2, Failed = 3 (check Error Message) |
byte |
None. |
ImportedOn |
Date imported to SI |
date |
None. |
ErrorMessage |
Error message (populated if StatusId = 3 (Failed) |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "5f4ad9ad-f8ed-4286-8cbf-f2ed44747e6e", "TypeId": 64, "StatusId": 64, "ImportedOn": "2024-04-29T11:16:18.5827078+00:00", "ErrorMessage": "sample string 4" }
application/xml, text/xml
Sample:
<MessageStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects"> <ErrorMessage>sample string 4</ErrorMessage> <Id>5f4ad9ad-f8ed-4286-8cbf-f2ed44747e6e</Id> <ImportedOn>2024-04-29T11:16:18.5827078+00:00</ImportedOn> <StatusId>64</StatusId> <TypeId>64</TypeId> </MessageStatus>