Application Broker 3.10 Messaging Service

Click here for a complete list of operations.

sendMessage

Creates a new message regarding the specified case, and notifies the other party. Valid for 3.7 cases and later, except cases in states 'archived', 'cancelled', 'cancelsent', 'deleted', 'draft' and 'rejected'.

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.10/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>
    <sendMessage xmlns="http://services.vd.dk/2010/applicationbroker/">
      <Request>
        <LoginToken>string</LoginToken>
        <CaseIdentifier>int</CaseIdentifier>
        <MessageText>string</MessageText>
        <Attachments>
          <tAttachment>
            <FileName>string</FileName>
            <URI>string</URI>
            <Content>string</Content>
            <MimeCode>string</MimeCode>
            <CommentText>string</CommentText>
          </tAttachment>
          <tAttachment>
            <FileName>string</FileName>
            <URI>string</URI>
            <Content>string</Content>
            <MimeCode>string</MimeCode>
            <CommentText>string</CommentText>
          </tAttachment>
        </Attachments>
      </Request>
    </sendMessage>
  </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>
    <sendMessageResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
      <sendMessageResult>
        <Meta>
          <Success>boolean</Success>
          <Errors>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
          </Errors>
        </Meta>
        <MessageIdentifier>int</MessageIdentifier>
        <AttachmentIdentifiers>
          <int>int</int>
          <int>int</int>
        </AttachmentIdentifiers>
      </sendMessageResult>
    </sendMessageResponse>
  </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.10/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>
    <sendMessage xmlns="http://services.vd.dk/2010/applicationbroker/">
      <Request>
        <LoginToken>string</LoginToken>
        <CaseIdentifier>int</CaseIdentifier>
        <MessageText>string</MessageText>
        <Attachments>
          <tAttachment>
            <FileName>string</FileName>
            <URI>string</URI>
            <Content>string</Content>
            <MimeCode>string</MimeCode>
            <CommentText>string</CommentText>
          </tAttachment>
          <tAttachment>
            <FileName>string</FileName>
            <URI>string</URI>
            <Content>string</Content>
            <MimeCode>string</MimeCode>
            <CommentText>string</CommentText>
          </tAttachment>
        </Attachments>
      </Request>
    </sendMessage>
  </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>
    <sendMessageResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
      <sendMessageResult>
        <Meta>
          <Success>boolean</Success>
          <Errors>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
          </Errors>
        </Meta>
        <MessageIdentifier>int</MessageIdentifier>
        <AttachmentIdentifiers>
          <int>int</int>
          <int>int</int>
        </AttachmentIdentifiers>
      </sendMessageResult>
    </sendMessageResponse>
  </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.10/messaging.wso/sendMessage HTTP/1.1
Host: ab.vd.dk
Content-Type: application/json; charset=utf-8
Content-Length: length
{
  "Request": {
    "LoginToken": string,
    "CaseIdentifier": int,
    "MessageText": string,
    "Attachments": [
      {        
        "FileName": string,
        "URI": string,
        "Content": string,
        "MimeCode": string,
        "CommentText": string
      },
      {        
        "FileName": string,
        "URI": string,
        "Content": string,
        "MimeCode": string,
        "CommentText": string
      }
    ]
  }
}

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
      }
    ]
  },
  "MessageIdentifier": int,
  "AttachmentIdentifiers": [
    int,
    int
  ]
}