Adlib API home page > API

API

The available API commands have been organised into the following six categories:

  • Search: AutoComplete, GetContent, GetDomains, GetMetaData, GetPointerfile, ListPointerfiles, Scan, Search, SearchPointerFiles.
  • Write: DeletePointerfile, DeleteRecord, InsertPointerfile, InsertRecord, UpdatePointerFile, UpdateRecord, Validate, ValidateRecord, WriteContent, WritePointerFile, WriteRecord.
  • Session: Login, Logout, EndSession, StartSession.
  • Lock: LockRecord, UnlockRecord.
  • Utilities: GetVersion, ListDatabases.
  • Select: DeSelectAll, DeSelectRecord, GetSelections, SelectAll, SelectRecord, ToggleAll.

Use the API browser on the left to search for documentation in these categories.

Command descriptions may have been split up over more than one tab, to exemplify its use with either URL requests, with Adlib.Data or jQuery. Arguments are listed per command: if a parameter has not been marked [optional], then the relevant parameter is mandatory.

All commands return XML (except getcontent and that all produced XML (even an error message or metadata) conforms to the AdlibXML schema definition: http://www.adlibsoft.com/adlibXML.xsd

Note that some examples might not work correctly in Mozilla Firefox; Microsoft Internet Explorer is the preferred browser for this website. Examples might also not work because other write and/or delete queries may have changed the available data; as necessary, backups will be restored on a regular basis to present the data as it should be as much as possible.

Using the Adlib Internet Server 3.1.2

The demo database used for the examples on this website can also be accessed with the Adlib Internet Server 3.1.2. This allows for a user-friendly way to examine the available demo data, in comparison to the results of API commands.

http://api.adlibsoft.com/internetserver3.1.2/default.aspx