Application Broker 3.8 Query Service

Click here for a complete list of operations.

fetchResultSummaries

Returns a number of results (Case and CaseSet ID's, a summary of the Case details and a list of valid actions) from the specified query, along with an indication of whether there might be more results.

MaxCases must be 1 or greater. SortOrder is ignored. Direction can be 'asc' (oldest cases first) or 'desc' (newest cases first).

The first unfetched results in the specified direction will be returned.

The list of actions refers mainly to methods of the Core Service. Two special actions 'READ' (meaning all get* methods) and 'EDIT' (meaning all add*, update* and remove* methods) exist.

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/query.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>
    <fetchResultSummaries xmlns="http://services.vd.dk/2010/applicationbroker/">
      <Request>
        <LoginToken>string</LoginToken>
        <SearchID>int</SearchID>
        <MaxCases>int</MaxCases>
        <SortOrder>string</SortOrder>
        <Direction>string</Direction>
      </Request>
    </fetchResultSummaries>
  </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>
    <fetchResultSummariesResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
      <fetchResultSummariesResult>
        <Meta>
          <Success>boolean</Success>
          <Errors>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
          </Errors>
        </Meta>
        <ResultSummaries>
          <tResultSummary>
            <CaseSetIdentifier>int</CaseSetIdentifier>
            <CaseIdentifier>int</CaseIdentifier>
            <ApplicantIdentifier>int</ApplicantIdentifier>
            <SerialNumber>int</SerialNumber>
            <ReferenceNumber>string</ReferenceNumber>
            <UserCode>string</UserCode>
            <AuthorityCode>string</AuthorityCode>
            <TypeCode>string</TypeCode>
            <VariantCode>string</VariantCode>
            <SiteSummary>string</SiteSummary>
            <Dates>
              <tCaseDate>
                <Name>string</Name>
                <Timestamp>dateTime</Timestamp>
              </tCaseDate>
              <tCaseDate>
                <Name>string</Name>
                <Timestamp>dateTime</Timestamp>
              </tCaseDate>
            </Dates>
            <StateCode>string</StateCode>
            <ValidOperations>
              <string>string</string>
              <string>string</string>
            </ValidOperations>
            <ResultCode>string</ResultCode>
          </tResultSummary>
          <tResultSummary>
            <CaseSetIdentifier>int</CaseSetIdentifier>
            <CaseIdentifier>int</CaseIdentifier>
            <ApplicantIdentifier>int</ApplicantIdentifier>
            <SerialNumber>int</SerialNumber>
            <ReferenceNumber>string</ReferenceNumber>
            <UserCode>string</UserCode>
            <AuthorityCode>string</AuthorityCode>
            <TypeCode>string</TypeCode>
            <VariantCode>string</VariantCode>
            <SiteSummary>string</SiteSummary>
            <Dates>
              <tCaseDate>
                <Name>string</Name>
                <Timestamp>dateTime</Timestamp>
              </tCaseDate>
              <tCaseDate>
                <Name>string</Name>
                <Timestamp>dateTime</Timestamp>
              </tCaseDate>
            </Dates>
            <StateCode>string</StateCode>
            <ValidOperations>
              <string>string</string>
              <string>string</string>
            </ValidOperations>
            <ResultCode>string</ResultCode>
          </tResultSummary>
        </ResultSummaries>
        <IsComplete>boolean</IsComplete>
      </fetchResultSummariesResult>
    </fetchResultSummariesResponse>
  </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/query.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>
    <fetchResultSummaries xmlns="http://services.vd.dk/2010/applicationbroker/">
      <Request>
        <LoginToken>string</LoginToken>
        <SearchID>int</SearchID>
        <MaxCases>int</MaxCases>
        <SortOrder>string</SortOrder>
        <Direction>string</Direction>
      </Request>
    </fetchResultSummaries>
  </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>
    <fetchResultSummariesResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
      <fetchResultSummariesResult>
        <Meta>
          <Success>boolean</Success>
          <Errors>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
          </Errors>
        </Meta>
        <ResultSummaries>
          <tResultSummary>
            <CaseSetIdentifier>int</CaseSetIdentifier>
            <CaseIdentifier>int</CaseIdentifier>
            <ApplicantIdentifier>int</ApplicantIdentifier>
            <SerialNumber>int</SerialNumber>
            <ReferenceNumber>string</ReferenceNumber>
            <UserCode>string</UserCode>
            <AuthorityCode>string</AuthorityCode>
            <TypeCode>string</TypeCode>
            <VariantCode>string</VariantCode>
            <SiteSummary>string</SiteSummary>
            <Dates>
              <tCaseDate>
                <Name>string</Name>
                <Timestamp>dateTime</Timestamp>
              </tCaseDate>
              <tCaseDate>
                <Name>string</Name>
                <Timestamp>dateTime</Timestamp>
              </tCaseDate>
            </Dates>
            <StateCode>string</StateCode>
            <ValidOperations>
              <string>string</string>
              <string>string</string>
            </ValidOperations>
            <ResultCode>string</ResultCode>
          </tResultSummary>
          <tResultSummary>
            <CaseSetIdentifier>int</CaseSetIdentifier>
            <CaseIdentifier>int</CaseIdentifier>
            <ApplicantIdentifier>int</ApplicantIdentifier>
            <SerialNumber>int</SerialNumber>
            <ReferenceNumber>string</ReferenceNumber>
            <UserCode>string</UserCode>
            <AuthorityCode>string</AuthorityCode>
            <TypeCode>string</TypeCode>
            <VariantCode>string</VariantCode>
            <SiteSummary>string</SiteSummary>
            <Dates>
              <tCaseDate>
                <Name>string</Name>
                <Timestamp>dateTime</Timestamp>
              </tCaseDate>
              <tCaseDate>
                <Name>string</Name>
                <Timestamp>dateTime</Timestamp>
              </tCaseDate>
            </Dates>
            <StateCode>string</StateCode>
            <ValidOperations>
              <string>string</string>
              <string>string</string>
            </ValidOperations>
            <ResultCode>string</ResultCode>
          </tResultSummary>
        </ResultSummaries>
        <IsComplete>boolean</IsComplete>
      </fetchResultSummariesResult>
    </fetchResultSummariesResponse>
  </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/query.wso/fetchResultSummaries HTTP/1.1
Host: ab.vd.dk
Content-Type: application/json; charset=utf-8
Content-Length: length
{
  "Request": {
    "LoginToken": string,
    "SearchID": int,
    "MaxCases": int,
    "SortOrder": string,
    "Direction": 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
      }
    ]
  },
  "ResultSummaries": [
    {      
      "CaseSetIdentifier": int,
      "CaseIdentifier": int,
      "ApplicantIdentifier": int,
      "SerialNumber": int,
      "ReferenceNumber": string,
      "UserCode": string,
      "AuthorityCode": string,
      "TypeCode": string,
      "VariantCode": string,
      "SiteSummary": string,
      "Dates": [
        {          
          "Name": string,
          "Timestamp": dateTime
        },
        {          
          "Name": string,
          "Timestamp": dateTime
        }
      ],
      "StateCode": string,
      "ValidOperations": [
        string,
        string
      ],
      "ResultCode": string
    },
    {      
      "CaseSetIdentifier": int,
      "CaseIdentifier": int,
      "ApplicantIdentifier": int,
      "SerialNumber": int,
      "ReferenceNumber": string,
      "UserCode": string,
      "AuthorityCode": string,
      "TypeCode": string,
      "VariantCode": string,
      "SiteSummary": string,
      "Dates": [
        {          
          "Name": string,
          "Timestamp": dateTime
        },
        {          
          "Name": string,
          "Timestamp": dateTime
        }
      ],
      "StateCode": string,
      "ValidOperations": [
        string,
        string
      ],
      "ResultCode": string
    }
  ],
  "IsComplete": boolean
}