GetAllUsers1 API¶

Returns a paged and filtered list of infoRouter users with full detail, supporting sorting, status filtering, and text-based field filters.

Endpoint¶

/srv.asmx/GetAllUsers1

Methods¶

GET /srv.asmx/GetAllUsers1?authenticationTicket=...&StartingRowNumber=...&NumbeOfRow=...&...
POST /srv.asmx/GetAllUsers1 (form data)
SOAP Action: http://tempuri.org/GetAllUsers1

Parameters¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`StartingRowNumber`	int	Yes	Zero-based index of the first row to return. Use `0` to start from the beginning.
`NumbeOfRow`	int	Yes	Number of rows per page.
`firstNameFilter`	string	No	Filter by first name (partial match). Pass empty or null for no filter.
`lastNameFilter`	string	No	Filter by last name (partial match). Pass empty or null for no filter.
`userNameFilter`	string	No	Filter by username (partial match). Pass empty or null for no filter.
`emailFilter`	string	No	Filter by email address (partial match). Pass empty or null for no filter.
`authenticationSourceFilter`	string	No	Filter by authentication source (partial match). Pass empty or null for no filter.
`domainNameFilter`	string	No	Filters local users by their home library, given by name or as `~L<id>` with the library's id. It does not test library membership, and global users never match. A library that is not there is refused. Pass empty or null for no filter.
`StatusFilter`	int	Yes	Filter by account status. Valid values: `-1` = no filter (all users), `0` = disabled only, `1` = enabled only.
`SortBy`	int	Yes	Sort field. Valid values: `0` = default (first name + last name ascending), `1` = username, `2` = first name + last name, `3` = last name + first name, `4` = email, `5` = status, `6` = authentication source, `7` = domain/library, `8` = user type.
`SortAscending`	bool	Yes	If `true`, sort in ascending order; if `false`, sort in descending order.

Response¶

Success Response¶

Returns a <users> collection with a totalusercount attribute on the root <response> element indicating the total number of matching users (across all pages).

<response success="true" error="" totalusercount="150">
  <users>
    <User exists="true"
          UserID="123"
          FirstName="Jane"
          LastName="Doe"
          Email="jane.doe@example.com"
          Enabled="TRUE"
          UserName="janedoe"
          Domain="Finance"
          LastLogonDate="2024-01-10"
          LastPasswordChangeDate="2024-01-01"
          AuthenticationAuthority="native"
          ReadOnlyUser="FALSE">
      <Preferences Language="English"
                   DefaultPortal=""
                   ShowArchives="FALSE"
                   ShowHiddens="FALSE"
                   NotificationType="INSTANT"
                   NotificationTypeId="1"
                   EmailType="HTML"
                   AttachDocumentToEmail="FALSE" />
    </User>
  </users>
</response>

Error Response¶

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

Required Permissions¶

System administrator. Only system administrators can list all users.

Example¶

GET Request (first page, enabled users only, sorted by username)¶

GET /srv.asmx/GetAllUsers1
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &StartingRowNumber=0
  &NumbeOfRow=25
  &firstNameFilter=
  &lastNameFilter=
  &userNameFilter=
  &emailFilter=
  &authenticationSourceFilter=
  &domainNameFilter=Finance
  &StatusFilter=1
  &SortBy=1
  &SortAscending=true
HTTP/1.1

POST Request¶

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

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&StartingRowNumber=0
&NumbeOfRow=25
&StatusFilter=-1
&SortBy=2
&SortAscending=true

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:GetAllUsers1>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:StartingRowNumber>0</tns:StartingRowNumber>
      <tns:NumbeOfRow>25</tns:NumbeOfRow>
      <tns:StatusFilter>1</tns:StatusFilter>
      <tns:SortBy>2</tns:SortBy>
      <tns:SortAscending>true</tns:SortAscending>
    </tns:GetAllUsers1>
  </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;
}

A page of users, filtered.

const root = await call('GetAllUsers1', {
  authenticationTicket: ticket,
  StartingRowNumber: 0,
  NumbeOfRow: 50,                 // spelled this way on the wire
  firstNameFilter: '',
  lastNameFilter: '',
  userNameFilter: 'jsmith',
  emailFilter: '',
  authenticationSourceFilter: '',
  domainNameFilter: '',
  StatusFilter: -1,               // -1 any, 0 disabled, 1 enabled
  SortBy: 1,
  SortAscending: true,
});

const total = Number(root.getAttribute('totalusercount'));  // the whole match, not the page

NumbeOfRow is spelled without the r; that is the parameter name the service takes. GetAllUsers2 is the same call with a user type filter added and the names tidied.

Notes¶

The totalusercount attribute on the <response> element shows the total count of matching users across all pages, not just the current page.
Use StartingRowNumber and NumbeOfRow to implement pagination. For example, to get page 3 with 25 rows per page, set StartingRowNumber=50 and NumbeOfRow=25.
Text filters perform partial (contains) matching.
Each <User> element includes a child <Preferences> element with notification and display settings.
To filter by user type (author vs read-only), use GetAllUsers2.

GetAllUsers - Get all users without pagination
GetAllUsers2 - Paged list with additional user type filter
GetAllUsersWithoutDetails - Paged list without preference details
GetUser - Get full properties of a specific user

Error Codes¶

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

`errorCode`	When
`4010`	the ticket is expired or unknown, or there is no ticket at all
`4030`	the caller is not a system administrator
`HTTP 400`	a required string parameter was empty; refused by model binding, so there is no error document

Every filter has to be present - they are declared as plain strings, so an omitted one is an HTTP 400 rather than "no filter". Send an empty string for the ones you do not want, -1 for the status and type filters.