WebAPI commands
The available WebAPI commands have been organised into the following categories (some commands fit into more than one category) to help you find the command you are looking for more quickly:
- Search: search, q, scan, suggest, autocomplete, facets (deprecated).
- Write: validate, validaterecord, insertrecord, updaterecord, writecontent, deleterecord, insertpointerfile, updatepointerfile, deletepointerfile.
- Session: login, startsession, endsession, logout.
- Select: selectrecord, selectall, getselections, deselectrecord, deselectall, toggleall.
- Lock: lockrecord, unlockrecord.
- Utilities: listdatabases, getversion, getmetadata, getdomains, getmediainfo, getdeletedrecords.
- Pointer files: listpointerfiles, searchpointerfiles, getpointerfile, insertpointerfile, updatepointerfile, deletepointerfile.
- Images: getcontent, writecontent, getmediainfo.
Click any of the categories and commands listed in the sub menus on the left for the full documentation.
A command description pertains to the use of the command in either (or both) 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 all generated XML (even an error message or metadata) conforms to the Axiell AdlibXML schema definition: adlibXML.xsd
Note that some examples might not work correctly in Mozilla Firefox; Microsoft Edge 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 in the demo database; as necessary, backups will be restored on a regular basis to present the data as it should be as much as possible.
Using Axiell Internet Server 6
Axiell Collections databases can also be accessed by Axiell Internet Server, currently at version 6. AIS is a GUI layer on top of the WebAPI, allowing for a user-friendly way to search, view and process data.
Feedback
