Search
Currently the following search parameters are supported by the ROD search endpoint in http://solsa.crystallography.net/rod/result:
- id – a string containing one or more ROD IDs separated by a comma (",") or a new line ("\n") symbol. The percent ("%") wild card symbol can be used to specify a range of IDs.;
- text – a keyword that must be contained in the metadata of the entry. The metadata search covers data such as the bibliographic information of the associated publication, common and systematic name of the sample compound and the name of the sample mineral;
- format – the format in which the results will be returned. Supported formats:
- html – a html web page displaying the list of ROD entries;
- csv – a csv file containing information about the ROD entries. The provided information matches the one provided by the ROD MySQL database;
- json – a json file containing information about the ROD entries. The provided information matches the one provided by the ROD MySQL database;
- lst – a txt file containing a list of ROD IDs;
- urls – a txt file containing a list of URLs pointing to the ROD CIF files;
- zip – a zip archive containing CIF files. Please note that there is a limit of how many entries can be returned using this format; in case this limit is reached, a html page with an error message is returned instead;
- count – the number of ROD entries that match the search criteria.
- formula – the empirical chemical formula of the crystal. Chemical element symbols in the formula must be ordered according to the Hill notation and separated by a space symbol, i.e. "C8 H10 N4 O2";
- el1, el2, ..., el8 – chemical element symbols that must appear in the chemical formula;
- nel1, nel2, ..., nel4 – chemical element symbols that must not appear in the chemical formula;
- strictmin, strictmax – the minimum/maximum number of distinct chemical elements that must appear in the chemical formula;
- amin, amax – the minimum/maximum value of the lattice parameter a;
- bmin, bmax – the minimum/maximum value of the lattice parameter b;
- cmin, cmax – the minimum/maximum value of the lattice parameter c;
- alpmin, alpmax – the minimum/maximum value of the lattice parameter alpha;
- betmin, betmax – the minimum/maximum value of the lattice parameter beta;
- gamin, gamax – the minimum/maximum value of the lattice parameter gamma;
- vmin, vmax – the minimum/maximum volume of the lattice;
- minZ, maxZ – the minimum/maximum Z value of the lattice;
- minZprime, maxZprime – the minimum/maximum Z' value of the lattice;
- journal – the name of the journal in which the scientific paper describing the crystal structure was published;
- year – the year of publication of the crystal structure;
- volume – the volume of the journal where the scientific paper describing the crystal structure was published;
- issue – the issue of the journal where the scientific paper describing the crystal structure was published;
- doi – the DOI that links to the online paper in which the crystal structure was published;
- has_fobs – flag value denoting that entries must have an associated X-ray reflection files (Fobs or Iobs data) in the ROD which contain the original reflection intensities used to determine the structures;
- include_duplicates – flag value denoting that entries that are marked as duplicates of other entries in the ROD should not be excluded;
- include_errors – flag value denoting that entries that are marked as having errors should not be excluded;
- exclude_experimental – flag value denoting that entries that are marked as experimental should be excluded;
- exclude_theoretical – flag value denoting that entries that are marked as theoretical should be excluded.
Entry access
Each database entry can be accessed by appending its ID to http://solsa.crystallography.net/rod/ and postfixing it by the format, for example, request http://solsa.crystallography.net/rod/1000000.cif results in retrieval of CIF contents of ROD entry 1000000.
Supported formats:
- rod;
- jdx – spectral data in JCAMP-DX format;
- hkl – diffraction data (if an entry has associated diffraction data);
- html – HTML information table for the entry;
- rdf – entry data in Resource Description Framework format.
Entry access will always return the newest version of the data. Specific revisions could be accessed for ROD and HKL formats by appending revision number preceded by "@", for example, request http://solsa.crystallography.net/rod/1000000.cif@2 results in retrieval of CIF contents of ROD entry 1000000 as of revision 2.