s1 API Host

<back to all web services

GetUrgentMessageRequest

The following routes are available for this service:
GET, OPTIONS/api/urgentmessages/{id}Get an urgent message.User has to be authenticated and needs to be an admin.
Parameters:
NameParameterData TypeRequiredDescription
IdpathintYesThe id of the urgent message.

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetUrgentMessageRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<GetUrgentMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages">
  <Id>0</Id>
</GetUrgentMessageRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUrgentMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <UrgentMessage>
    <EndDate>0001-01-01T00:00:00</EndDate>
    <Id>0</Id>
    <Level>Info</Level>
    <Message>String</Message>
    <StartDate>0001-01-01T00:00:00</StartDate>
    <Title>String</Title>
  </UrgentMessage>
  <UrgentMessages i:nil="true" />
</GetUrgentMessageResponse>