GET api/CriticalMessage/{id}
Returns a specific CriticalMessage record by CriticalMessageId
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CriticalMessageName | Description | Type | Additional information |
---|---|---|---|
CriticalMessageId |
The Critical_Message_Id from the SY_Critical_Message table |
integer |
None. |
CustomerId |
The Customer_Id foreign key from the AR_Customer_CC table; must reference a record in the AR_Customer |
integer |
Required |
Expires |
Date the message expires, this is not required but if left null, it will not have an expiration date and will show indefinitely |
string |
None. |
Message |
Text of the message |
string |
Required |
Username |
Username for the author of the message |
string |
None. |
CustomerSiteId |
Foreign key from AR_Customer_Site table, provide if the message references a site record |
integer |
None. |
CustomerSystemId |
Foreign key from AR_Customer_System table, provide if the message references a system record |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "CriticalMessageId": 1, "CustomerId": 2, "Expires": "sample string 3", "Message": "sample string 4", "Username": "sample string 5", "CustomerSiteId": 1, "CustomerSystemId": 1 }
application/xml, text/xml
Sample:
<CriticalMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models"> <CriticalMessageId>1</CriticalMessageId> <CustomerId>2</CustomerId> <CustomerSiteId>1</CustomerSiteId> <CustomerSystemId>1</CustomerSystemId> <Expires>sample string 3</Expires> <Message>sample string 4</Message> <Username>sample string 5</Username> </CriticalMessage>