Application Broker 3.7 Core Service

Click here for a complete list of operations.

approveAmendment

Approves an amendment application, updating the Case with the amendment data, and issues a revised permission document to the applicant.

The state of the Case will change to 'permitted'.

This operation is only valid for the authority and only in the Case state 'amendsent'.

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.7/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>
    <approveAmendment xmlns="http://services.vd.dk/2010/applicationbroker/">
      <Request>
        <LoginToken>string</LoginToken>
        <CaseIdentifier>int</CaseIdentifier>
        <PermissionDocument>
          <FileName>string</FileName>
          <URI>string</URI>
          <Content>string</Content>
          <MimeCode>string</MimeCode>
          <CommentText>string</CommentText>
        </PermissionDocument>
        <TermsDocuments>
          <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>
        </TermsDocuments>
        <OtherDocuments>
          <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>
        </OtherDocuments>
        <CommentText>string</CommentText>
      </Request>
    </approveAmendment>
  </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>
    <approveAmendmentResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
      <approveAmendmentResult>
        <Meta>
          <Success>boolean</Success>
          <Errors>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
          </Errors>
        </Meta>
        <AttachmentIdentifiers>
          <int>int</int>
          <int>int</int>
        </AttachmentIdentifiers>
      </approveAmendmentResult>
    </approveAmendmentResponse>
  </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.7/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>
    <approveAmendment xmlns="http://services.vd.dk/2010/applicationbroker/">
      <Request>
        <LoginToken>string</LoginToken>
        <CaseIdentifier>int</CaseIdentifier>
        <PermissionDocument>
          <FileName>string</FileName>
          <URI>string</URI>
          <Content>string</Content>
          <MimeCode>string</MimeCode>
          <CommentText>string</CommentText>
        </PermissionDocument>
        <TermsDocuments>
          <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>
        </TermsDocuments>
        <OtherDocuments>
          <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>
        </OtherDocuments>
        <CommentText>string</CommentText>
      </Request>
    </approveAmendment>
  </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>
    <approveAmendmentResponse xmlns="http://services.vd.dk/2010/applicationbroker/">
      <approveAmendmentResult>
        <Meta>
          <Success>boolean</Success>
          <Errors>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
            <tErrorReport>
              <ErrorCode>int</ErrorCode>
              <ErrorText>string</ErrorText>
            </tErrorReport>
          </Errors>
        </Meta>
        <AttachmentIdentifiers>
          <int>int</int>
          <int>int</int>
        </AttachmentIdentifiers>
      </approveAmendmentResult>
    </approveAmendmentResponse>
  </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.7/core.wso/approveAmendment HTTP/1.1
Host: ab.vd.dk
Content-Type: application/json; charset=utf-8
Content-Length: length
{
  "Request": {
    "LoginToken": string,
    "CaseIdentifier": int,
    "PermissionDocument": {
      "FileName": string,
      "URI": string,
      "Content": string,
      "MimeCode": string,
      "CommentText": string
    },
    "TermsDocuments": [
      {        
        "FileName": string,
        "URI": string,
        "Content": string,
        "MimeCode": string,
        "CommentText": string
      },
      {        
        "FileName": string,
        "URI": string,
        "Content": string,
        "MimeCode": string,
        "CommentText": string
      }
    ],
    "OtherDocuments": [
      {        
        "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
      }
    ]
  },
  "AttachmentIdentifiers": [
    int,
    int
  ]
}