Application Broker 3.8 Messaging Service
Click
here
for a complete list of operations.
getMessage
Returns the specified message, including any related attachments.
Test
The test form is not available with struct, array or byref parameter types. Please use a SOAP 1.1 or 1.2 compliant client program for testing of your web service.
SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /broker/3.8/messaging.wso HTTP/1.1
Host: ab.vd.dk
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<getMessage xmlns="http://services.vd.dk/2010/applicationbroker/">
<Request>
<LoginToken>string</LoginToken>
<MessageIdentifier>int</MessageIdentifier>
</Request>
</getMessage>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<getMessageResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
<getMessageResult>
<Meta>
<Success>boolean</Success>
<Errors>
<tErrorReport>
<ErrorCode>int</ErrorCode>
<ErrorText>string</ErrorText>
</tErrorReport>
<tErrorReport>
<ErrorCode>int</ErrorCode>
<ErrorText>string</ErrorText>
</tErrorReport>
</Errors>
</Meta>
<Message>
<MessageIdentifier>int</MessageIdentifier>
<CaseIdentifier>int</CaseIdentifier>
<Author>string</Author>
<Text>string</Text>
<Created>dateTime</Created>
<Attachments>
<tAttachmentEntity>
<AttachmentIdentifier>int</AttachmentIdentifier>
<Action>string</Action>
<Transaction>string</Transaction>
<Source>string</Source>
<Type>string</Type>
<FileName>string</FileName>
<URI>string</URI>
<MimeCode>string</MimeCode>
<CommentText>string</CommentText>
<Created>dateTime</Created>
<Failing>boolean</Failing>
</tAttachmentEntity>
<tAttachmentEntity>
<AttachmentIdentifier>int</AttachmentIdentifier>
<Action>string</Action>
<Transaction>string</Transaction>
<Source>string</Source>
<Type>string</Type>
<FileName>string</FileName>
<URI>string</URI>
<MimeCode>string</MimeCode>
<CommentText>string</CommentText>
<Created>dateTime</Created>
<Failing>boolean</Failing>
</tAttachmentEntity>
</Attachments>
</Message>
</getMessageResult>
</getMessageResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /broker/3.8/messaging.wso HTTP/1.1
Host: ab.vd.dk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<getMessage xmlns="http://services.vd.dk/2010/applicationbroker/">
<Request>
<LoginToken>string</LoginToken>
<MessageIdentifier>int</MessageIdentifier>
</Request>
</getMessage>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<getMessageResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
<getMessageResult>
<Meta>
<Success>boolean</Success>
<Errors>
<tErrorReport>
<ErrorCode>int</ErrorCode>
<ErrorText>string</ErrorText>
</tErrorReport>
<tErrorReport>
<ErrorCode>int</ErrorCode>
<ErrorText>string</ErrorText>
</tErrorReport>
</Errors>
</Meta>
<Message>
<MessageIdentifier>int</MessageIdentifier>
<CaseIdentifier>int</CaseIdentifier>
<Author>string</Author>
<Text>string</Text>
<Created>dateTime</Created>
<Attachments>
<tAttachmentEntity>
<AttachmentIdentifier>int</AttachmentIdentifier>
<Action>string</Action>
<Transaction>string</Transaction>
<Source>string</Source>
<Type>string</Type>
<FileName>string</FileName>
<URI>string</URI>
<MimeCode>string</MimeCode>
<CommentText>string</CommentText>
<Created>dateTime</Created>
<Failing>boolean</Failing>
</tAttachmentEntity>
<tAttachmentEntity>
<AttachmentIdentifier>int</AttachmentIdentifier>
<Action>string</Action>
<Transaction>string</Transaction>
<Source>string</Source>
<Type>string</Type>
<FileName>string</FileName>
<URI>string</URI>
<MimeCode>string</MimeCode>
<CommentText>string</CommentText>
<Created>dateTime</Created>
<Failing>boolean</Failing>
</tAttachmentEntity>
</Attachments>
</Message>
</getMessageResult>
</getMessageResponse>
</soap12:Body>
</soap12:Envelope>
JSON
The following is a sample JSON request and response. The placeholders shown need to be replaced with actual values.
POST /broker/3.8/messaging.wso/getMessage HTTP/1.1
Host: ab.vd.dk
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"Request": {
"LoginToken": string,
"MessageIdentifier": int
}
}
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"Meta": {
"Success": boolean,
"Errors": [
{
"ErrorCode": int,
"ErrorText": string
},
{
"ErrorCode": int,
"ErrorText": string
}
]
},
"Message": {
"MessageIdentifier": int,
"CaseIdentifier": int,
"Author": string,
"Text": string,
"Created": dateTime,
"Attachments": [
{
"AttachmentIdentifier": int,
"Action": string,
"Transaction": string,
"Source": string,
"Type": string,
"FileName": string,
"URI": string,
"MimeCode": string,
"CommentText": string,
"Created": dateTime,
"Failing": boolean
},
{
"AttachmentIdentifier": int,
"Action": string,
"Transaction": string,
"Source": string,
"Type": string,
"FileName": string,
"URI": string,
"MimeCode": string,
"CommentText": string,
"Created": dateTime,
"Failing": boolean
}
]
}
}