SetClassificationLevel API¶

Sets the classification level of the specified document or folder. Classification markings control access visibility and are recorded in the classification change log. Optional downgrade and declassify dates can be provided for classified levels (Confidential, Secret, Top Secret).

Endpoint¶

/srv.asmx/SetClassificationLevel

Methods¶

• GET /srv.asmx/SetClassificationLevel?AuthenticationTicket=...&Path=...&ClassificationLevel=...

• POST /srv.asmx/SetClassificationLevel (form data)

• SOAP Action: http://tempuri.org/SetClassificationLevel

Parameters¶

Classification Level Values¶

Note: DowngradeOn and DeclassifyOn are silently ignored (reset to no-date) when ClassificationLevel is 0 (NoMarkings) or 1 (Declassified), as these dates are only meaningful for classified items.

Response¶

Success Response¶

<response success="true" error="" />

Error Response¶

<response success="false" error="Access denied." />

Required Permissions¶

The calling user must have Change Classification permission on the target document or folder.

Example¶

GET Request¶

GET /srv.asmx/SetClassificationLevel

  ?AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &Path=/Finance/Reports/Q1-2024-Report.pdf

  &ClassificationLevel=3

  &DowngradeOn=2026-01-01

  &DeclassifyOn=2030-01-01

  &ReasonForAction=Annual+review

  &Agency=Finance+Dept

HTTP/1.1

POST Request¶

POST /srv.asmx/SetClassificationLevel HTTP/1.1

Content-Type: application/x-www-form-urlencoded

AuthenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

&Path=/Finance/Reports/Q1-2024-Report.pdf

&ClassificationLevel=3

&DowngradeOn=2026-01-01

&DeclassifyOn=2030-01-01

&ReasonForAction=Annual+review

&Agency=Finance+Dept

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

               xmlns:tns="http://tempuri.org/">

  <soap:Body>

    <tns:SetClassificationLevel>

      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>

      <tns:Path>/Finance/Reports/Q1-2024-Report.pdf</tns:Path>

      <tns:ClassificationLevel>3</tns:ClassificationLevel>

      <tns:DowngradeOn>2026-01-01</tns:DowngradeOn>

      <tns:DeclassifyOn>2030-01-01</tns:DeclassifyOn>

      <tns:ReasonForAction>Annual review</tns:ReasonForAction>

      <tns:Agency>Finance Dept</tns:Agency>

    </tns:SetClassificationLevel>

  </soap:Body>

</soap:Envelope>

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Sets the classification of a document, with the dates it should be downgraded and declassified on.

await call('SetClassificationLevel', {
  authenticationTicket: ticket,
  Path: '/Defence/Reports/Q1.pdf',
  ClassificationLevel: 2,            // 0 NoMarkings, 1 Declassified, 2 Confidential, 3 Secret, 4 TopSecret
  DowngradeOn: '',
  DeclassifyOn: '2030-01-01',
  ReasonForAction: 'Contains supplier pricing',
  Agency: 'Procurement'
});

The folder has to allow classified documents first. The ClassifiedDocuments rule is checked before anything else, and a folder that disallows them answers 4030 however valid the rest of the call is - see SetFolderRules. Setting the level back to 0 declassifies a document and is allowed wherever the document may be changed.

A level outside 0 to 4 is refused 4000 with the five named in the message.

Notes¶

• Both documents and folders are supported. The path is resolved as a document first; if no document is found, it is resolved as a folder.

• For documents: if setting a classified level (Confidential, Secret, or Top Secret), the parent folder must allow classified documents (controlled by the ALLOWCLASSIFIEDDOCUMENTS folder rule). If not, the call returns an error.

• For documents: document subscribers are notified of the classification change upon success.

• For folders: no subscriber notification is sent.

• DowngradeOn and DeclassifyOn accept UTC values, which are automatically converted to server local time.

• Classification changes are written to the classification change log (HistoryCLevelStore), recording the before/after levels, dates, reason, and agency.

• Passing ClassificationLevel=0 (NoMarkings) removes all classification markings from the item.

Related APIs¶

• GetDocument - Get document properties including the current classification level and dates

Error Codes¶

The errorCode values this operation returns, checked against a running server: