Application Broker 3.13 Core Service

Click here for a complete list of operations.

progressCaseX

NEW IN 3.13! Sends a progress report ('temporary completion') for a Case.

This version includes the option of specifying completion details.

The state of the Case will change to 'progsent', unless it is 'draft' in which case it won't change.

Mandatory fields include ProgressText.

This operation is only valid for the applicant and only in the Application states 'draft' (report variant only), 'permitted', 'progsent' or 'progrec'.

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.13/core.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>
    <progressCaseX xmlns="http://services.vd.dk/2010/applicationbroker/">
      <Request>
        <LoginToken>string</LoginToken>
        <CaseIdentifier>int</CaseIdentifier>
        <ProgressText>string</ProgressText>
        <Details>
          <tDetail>
            <Name>string</Name>
            <Value>string</Value>
          </tDetail>
          <tDetail>
            <Name>string</Name>
            <Value>string</Value>
          </tDetail>
        </Details>
        <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>
        <CommentText>string</CommentText>
      </Request>
    </progressCaseX>
  </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>
    <progressCaseXResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
      <progressCaseXResult>
        <Meta>
          <Success>boolean</Success>
          <Errors>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
          </Errors>
        </Meta>
      </progressCaseXResult>
    </progressCaseXResponse>
  </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.13/core.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>
    <progressCaseX xmlns="http://services.vd.dk/2010/applicationbroker/">
      <Request>
        <LoginToken>string</LoginToken>
        <CaseIdentifier>int</CaseIdentifier>
        <ProgressText>string</ProgressText>
        <Details>
          <tDetail>
            <Name>string</Name>
            <Value>string</Value>
          </tDetail>
          <tDetail>
            <Name>string</Name>
            <Value>string</Value>
          </tDetail>
        </Details>
        <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>
        <CommentText>string</CommentText>
      </Request>
    </progressCaseX>
  </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>
    <progressCaseXResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
      <progressCaseXResult>
        <Meta>
          <Success>boolean</Success>
          <Errors>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
          </Errors>
        </Meta>
      </progressCaseXResult>
    </progressCaseXResponse>
  </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.13/core.wso/progressCaseX HTTP/1.1
Host: ab.vd.dk
Content-Type: application/json; charset=utf-8
Content-Length: length
{
  "Request": {
    "LoginToken": string,
    "CaseIdentifier": int,
    "ProgressText": string,
    "Details": [
      {        
        "Name": string,
        "Value": string
      },
      {        
        "Name": string,
        "Value": string
      }
    ],
    "Attachments": [
      {        
        "FileName": string,
        "URI": string,
        "Content": string,
        "MimeCode": string,
        "CommentText": string
      },
      {        
        "FileName": string,
        "URI": string,
        "Content": string,
        "MimeCode": string,
        "CommentText": 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
      }
    ]
  }
}