XML Schema
The eLandings XML schema provides definitions for all XML documents used in the eLandings system. These include documents used by agency personnel, and documents used by the software internally. Only a subset of the XML document definitions are needed to interface an external system with eLandings.
The eLandings XML schema definition is contained in a number of files. The schema is partitioned so that systems that need only particular element definitions do not have to deal with elements that are not needed for their operations. The W3C XML schema allows schema definition files to include other files. The eLandings XML schema makes use of include statements.
The eLandings XML schema definition files are:
- datatypes.xsd - the data elements that are definitions of atomic data types. That is, the elements that are made from raw data types, and cannot be broken down further. Examples are the landing report id data element, and the weight data element. They contain data, but not structure. Atomic data elements may have attributes. For example, the condition code data element is a simple number containing the code, such as 1. The condition code data element has a attribute for _name-, which contains the name of the condition.
- dateelements.xsd - commonly used data elements that hold groups of individual elements, and that are used in multiple types of reports. For example, the cfec_permit data element, that is made up of the fishery, permit number, and year sequence. The data_elements may have both required and optional elements. While the XML schema defines elements as optional, the eLandings business rules determine when elements are required for particular reports.
- landingreport.xsd - the landing report data element definitions.
- productionreport.xsd - the production report data element definitions.
- logbook.xsd - the electronic logbook data element definitions.
- codes.xsd - the code table definitions for encoded data such as species codes, statistical area codes, condition codes, etc.
The eLandings system includes other XSD files that provide data element definitions that are used internally. Interfacing systems do not need these data elements.
The current and previous versions of the schema files are available online from the eLandings system support website.
XML Definitions for Interfacing Systems
The XML elements that are needed for system interfaces are:
The landing_report XML definition defines landing report data files that are extracted from eLandings and imported to another system. It is also used for files that are prepared by an external system and submitted to eLandings. Elements of the landing_report document and their usage are defined on the Landing Report Data page.
The landing_report_info XML definition defines the data returned when searching for landing reports. It contains the landing report IDs, which can then be used to retrieve the landing report documents.
The production_report XML definition defines production report data files that are extracted from eLandings and imported to another system. It also applies to files that are prepared by an external system and submitted to eLandings. Elements of the production_report document and their usage are defined on the Production Report Data page.
The production_report_info XML definition defines the data returned when searching for production reports. It contains the production report IDs, which can then be used to retrieve the production report documents. It is also used when getting information about electronic logbooks.
The number_info XML definition defines files that contain importable landing report, production report, and fish ticket numbers. These numbers must be obtained from the eLandings system before a report can be prepared for input to eLandings from an external system. Elements of the number_info document and their usage are defined on the Numbers Data page.
The processor_user_info XML definition defines files that contain the user authentication information needed when submitting landing or production reports to eLandings by email. Elements of the processor_user_info document and their usage are defined on the User Data page.
The logbook_report XML definition defines electronic logbook data files.
The daily_reporting XML definition defines Daily Reports, Trip Reports and Logobok Profile Reports