CreateDomain API¶

Creates a new infoRouter domain/library with the specified name and configuration. Domains (also called libraries) are the top-level containers in infoRouter that hold folders, documents, and workflow definitions.

Endpoint¶

/srv.asmx/CreateDomain

Methods¶

• GET /srv.asmx/CreateDomain?authenticationTicket=...&DomainName=...&Anonymous=...&Hidden=...&WelcomeMessage=...
• POST /srv.asmx/CreateDomain (form data)
• SOAP Action: http://tempuri.org/CreateDomain

Parameters¶

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="[ErrorCode] Error message" />

Required Permissions¶

System administrator only. Only the system administrator can create domains/libraries.

Example¶

GET Request (public domain with welcome message)¶

GET /srv.asmx/CreateDomain
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &DomainName=Finance
  &Anonymous=false
  &Hidden=false
  &WelcomeMessage=Welcome+to+the+Finance+Library
HTTP/1.1

GET Request (hidden anonymous domain)¶

GET /srv.asmx/CreateDomain
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &DomainName=PublicResources
  &Anonymous=true
  &Hidden=false
  &WelcomeMessage=
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&DomainName=Finance
&Anonymous=false
&Hidden=false
&WelcomeMessage=Finance department document library

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:CreateDomain>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:DomainName>Finance</tns:DomainName>
      <tns:Anonymous>false</tns:Anonymous>
      <tns:Hidden>false</tns:Hidden>
      <tns:WelcomeMessage>Finance department document library</tns:WelcomeMessage>
    </tns:CreateDomain>
  </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;
}

Makes a library.

await call('CreateDomain', {
  authenticationTicket: ticket,
  DomainName: 'Finance',
  Anonymous: false,      // readable without signing in
  Hidden: false,         // hidden from the library list
  WelcomeMessage: 'Finance department documents'
});

Whoever creates a library is a member of it, without being added - which matters, because a library with no members is unreachable. Creating one is an administrator's job: a caller without those rights is refused 4030, not 4010.

A name carrying a special character is refused with 4000, unlike a folder name, which is silently cleaned up.

A library and a domain are the same thing. The operations are named Domain, the messages say library, and the XML element is <domain>. Its flags come back as the words TRUE and FALSE rather than true/false.

A library must keep a member. Removing the last one is refused with 4000: a library is visible only to its members, so one with nobody in it cannot be reached by anyone, a system administrator included, and no operation on it - DeleteDomain among them - would work again. A member group counts only for the people in it.

Notes¶

• DomainName must be unique; creating a domain with an existing name returns an error.
• After creation, use AddUserAsDomainMember or AddUserGroupAsDomainMember to populate the domain with members.
• Use AddManagerToDomain to assign managers to the new domain.
• The WelcomeMessage supports multi-line text; newlines are preserved.
• Use CreateFolder to create sub-folders inside the new domain.
• To check if a domain already exists before creating, use DomainExists.
• The library's root folder starts with a list of its own: everyone may list. From 9.0 that list is the first entry on the library's security log (GetSecurityChangeLog), made by the creator, so the log says what the root had before any change to it, and the history of every item that inherits from the root has a floor to reach. The security history is always kept from 9.0; it is not a library policy.

Related APIs¶

• DeleteDomain - Delete a domain/library
• UpdateDomain - Update domain properties (name, visibility, welcome message)
• DomainExists - Check if a domain exists
• AddUserAsDomainMember - Add a user to the new domain
• GetDomain - Get domain properties

Error Codes¶

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