UpdateDocumentTypeDef1 API¶

Updates an existing document type definition. Allows renaming the document type, changing its required property set, and setting or clearing its default retention and disposition schedule.

Endpoint¶

/srv.asmx/UpdateDocumentTypeDef1

Methods¶

• GET /srv.asmx/UpdateDocumentTypeDef1?authenticationTicket=...&DocumentTypeId=...&NewDocumentTypeName=...&NewRequiredPropertySetName=...&RandDScheduleName=...&Description=...
• POST /srv.asmx/UpdateDocumentTypeDef1 (form data)
• SOAP Action: http://tempuri.org/UpdateDocumentTypeDef1

Parameters¶

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="Error message" />

Required Permissions¶

Only system administrators may call this API. An anonymous caller is refused with 4010, any other non-administrator with 4030, and both before the type is looked up.

Example¶

GET Request — rename and set schedule¶

GET /srv.asmx/UpdateDocumentTypeDef1
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &DocumentTypeId=5
  &NewDocumentTypeName=Financial+Report
  &NewRequiredPropertySetName=FinanceProperties
  &RandDScheduleName=Finance+Records+-+7+Years
  &Description=A+statement+of+account+activity+for+a+reporting+period
HTTP/1.1

GET Request — clear the schedule¶

GET /srv.asmx/UpdateDocumentTypeDef1
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &DocumentTypeId=5
  &NewDocumentTypeName=Financial+Report
  &NewRequiredPropertySetName=FinanceProperties
  &RandDScheduleName=
HTTP/1.1

POST Request¶

POST /srv.asmx/UpdateDocumentTypeDef1 HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&DocumentTypeId=5
&NewDocumentTypeName=Financial+Report
&NewRequiredPropertySetName=FinanceProperties
&RandDScheduleName=Finance+Records+-+7+Years
&Description=A+statement+of+account+activity+for+a+reporting+period

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:UpdateDocumentTypeDef1>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:DocumentTypeId>5</tns:DocumentTypeId>
      <tns:NewDocumentTypeName>Financial Report</tns:NewDocumentTypeName>
      <tns:NewRequiredPropertySetName>FinanceProperties</tns:NewRequiredPropertySetName>
      <tns:RandDScheduleName>Finance Records - 7 Years</tns:RandDScheduleName>
      <tns:Description>A statement of account activity for a reporting period</tns:Description>
    </tns:UpdateDocumentTypeDef1>
  </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;
}

UpdateDocumentTypeDef with two more things it can set: a retention and disposition schedule, and a description.

await call('UpdateDocumentTypeDef1', {
  authenticationTicket: ticket,
  DocumentTypeId: 1081,
  NewDocumentTypeName: 'Supplier Invoice',
  NewRequiredPropertySetName: 'INVOICE',
  RandDScheduleName: '',
  Description: 'Invoices received from suppliers'
});

The description is the only one of the two that comes back from GetDocumentTypes, so it is the simplest way to confirm the change landed.

Notes¶

• Renaming a document type affects all documents currently assigned to that type — they will reflect the new name immediately.
• Changing or removing the required property set may affect metadata validation for documents already assigned to this type.
• RandDScheduleName behavior:
• Omitted / null — the existing schedule is preserved unchanged.
• Empty string — the current default schedule is removed (sets DefaultRDDefID to 0).
• A schedule name — the named schedule becomes the new default. The schedule must already exist.
• Description behavior:
• Omitted / null — the existing description is preserved unchanged.
• Empty string — the current description is cleared.
• A sentence — becomes the new description. Maximum 255 characters, single line.
• Description is what infoRouter tells infoRouter Connect the type is, and Connect recognises a described type in a document noticeably better than one identified by its name alone. It is returned by GetDocumentTypes.
• Changes to the default retention schedule only affect documents assigned this type after the update. Existing documents are not retroactively updated.
• Use GetDocumentTypes to retrieve document type IDs and current configuration.

Related APIs¶

• UpdateDocumentTypeDef - Update a document type definition without changing its retention schedule
• CreateDocumentTypeDef1 - Create a document type with an optional retention schedule
• GetDocumentTypes - Retrieve all defined document type definitions
• UpdateDocumentType - Assign a document type to a specific document

Error Codes¶

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