GetMemberDomains API¶

Returns a list of domains/libraries where the currently authenticated user is a member. Results are sorted alphabetically by domain name.

Endpoint¶

/srv.asmx/GetMemberDomains

Methods¶

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

Parameters¶

Response¶

Success Response¶

Returns a <domains> collection with one <domain> element per member domain, sorted alphabetically by name.

<response success="true" error="">
  <domains>
    <domain DomainID="123"
            DomainName="Finance"
            AnonymousDomain="FALSE"
            IsArchive="FALSE"
            IsHidden="FALSE"
            WelcomeMessage="Welcome to the Finance Library" />
    <domain DomainID="456"
            DomainName="HR"
            AnonymousDomain="FALSE"
            IsArchive="FALSE"
            IsHidden="FALSE"
            WelcomeMessage="" />
  </domains>
</response>

If the user is not a member of any domain, the <domains> element is empty:

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

Error Response¶

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

Domain Element Attributes¶

Required Permissions¶

Any authenticated user can call this API. Anonymous (unauthenticated) users are rejected.

Example¶

GET Request¶

GET /srv.asmx/GetMemberDomains
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
HTTP/1.1

POST Request¶

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

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

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:GetMemberDomains>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
    </tns:GetMemberDomains>
  </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;
}

Lists the libraries the calling user belongs to - a subset of what GetDomains returns.

const root = await call('GetMemberDomains', { authenticationTicket: ticket });

There is no userName: it always answers for the caller, so an unticketed call is refused rather than answered for the anonymous user. Creating a library makes the creator a member of it.

Notes¶

• Returns only domains where the currently authenticated user is a member -" both direct memberships and memberships through user groups are included.
• Archived and hidden domains are included in the results if the user is a member.
• Results are sorted alphabetically by domain name.
• To get domain memberships for a specific user (not just the calling user), use GetDomainMembershipsOfUser.
• To get all domains in the system regardless of membership, use GetDomains.

Related APIs¶

• GetDomains - Get all domains in the system
• GetDomainMembershipsOfUser - Get domain memberships for a specific user
• AddUserAsDomainMember - Add the user to a domain
• GetDomain - Get properties of a specific domain

Error Codes¶

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