NetCard Server Web API

GetMqMessage

The following routes are available for this service:
GET	/MessageQueue/GetMessage

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/GetMqMessage HTTP/1.1 
Host: ncapi.net.au 
Content-Type: application/xml
Content-Length: length

<GetMqMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.MessageQueue">
  <MqServerSetting xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:Channel>String</d2p1:Channel>
    <d2p1:Port>0</d2p1:Port>
    <d2p1:QueueManager>String</d2p1:QueueManager>
    <d2p1:QueueName>String</d2p1:QueueName>
    <d2p1:ServerLocation>String</d2p1:ServerLocation>
  </MqServerSetting>
</GetMqMessage>

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

<GetMqMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.MessageQueue">
  <Message>String</Message>
  <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>
</GetMqMessageResponse>