AddManagerToDomain API¶

Adds an existing infoRouter user as a domain/library manager. The user must already be a member of the domain/library before being designated as a manager.

Endpoint¶

/srv.asmx/AddManagerToDomain

Methods¶

• GET /srv.asmx/AddManagerToDomain?authenticationTicket=...&DomainName=...&UserName=...
• POST /srv.asmx/AddManagerToDomain (form data)
• SOAP Action: http://tempuri.org/AddManagerToDomain

Parameters¶

Response¶

Success Response¶

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

Error Response¶

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

Required Permissions¶

Administrators and User Managers. Library managers cannot appoint other managers. The target user must already be a member of the domain/library.

A User Manager cannot appoint themselves: they may join any library, so it would make them a manager of every library. Only an administrator may appoint themselves.

Example¶

GET Request¶

GET /srv.asmx/AddManagerToDomain
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &DomainName=Finance
  &UserName=jdoe
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&DomainName=Finance
&UserName=jdoe

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:AddManagerToDomain>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:DomainName>Finance</tns:DomainName>
      <tns:UserName>jdoe</tns:UserName>
    </tns:AddManagerToDomain>
  </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 user a manager of a library.

await call('AddManagerToDomain', {
  authenticationTicket: ticket,
  DomainName: 'Finance',
  UserName: 'jsmith'
});

Adding the same manager twice is a success, unlike adding the same member twice, which is refused 4000. A user name nobody has is 4041.

A manager is not automatically a member: add them with AddUserAsDomainMember as well.

Notes¶

• The user must be an existing member of the domain/library before being made a manager. Use AddUserAsDomainMember first if the user is not yet a member.
• A domain can have multiple managers.
• Domain managers can manage members, workflows, and other domain settings.
• Use RemoveManagerFromDomain to revoke manager status without removing domain membership.
• Use GetManagers to retrieve the current list of managers for a domain.

Related APIs¶

• RemoveManagerFromDomain - Remove manager status from a user
• AddUserAsDomainMember - Add a user as a domain member
• GetManagers - Get the list of managers for a domain
• GetDomainMembers - Get all members of a domain

Error Codes¶

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