Changes to the NEMIS API

FY2023

v2.12 [2024-03-25]

• Added "100 (TRAWL SEINES)" to the hauls attribute gear_category

v2.11 [2023-05-01]

• Removed "REDFISH, ACADIAN" from the discard_event attribute species_code_itis
• Added "SCORPIONFISH, NK" to the discard_event attribute species_code_itis
• The discard_event attribute species_common_itis, deprecated for FY22, is now prohibited in FY23.
• New discard_event attribute disposition may be used for reviews in FY23:
  • 000 (DISCARDED UNKNOWN REASON)
• The description of an other_events attribute event_code has been updated:
  • BAG (RELEASED BAG)
  • WEATHER (WEATHER)
• The following other_events attribute event_code values have been deprecated and will not be accepted in reviews of trips after FY22:
  • IDCP (IMPROPER DELAYED CATCH PROCESSING)
  • SYSOFFPRIOR (SYSTEM TURNED OFF PRIOR TO LANDING)
• Herring endpoint hrg_detail has been deprecated and will not accept reviews of FY23 trips.

FY2022

v2.10 [2022-12-15]

• The API Constraints have added the following rules:
  • The other_event element event_duration attribute must be null or zero for event_code: SYSTEM, NAATDOCK, SYSOFFPRIOR, LIGHTORGLARE.
  • The other_event element event_duration attribute must not be null or zero for event_code: BAG, CAMMAINT, BULKDISC, CAMFAIL, SENSGAP, VIDGAP, COS, CAMKNOCK, IMGIMPAIR, WEATHER, IDCP, CAMDAMAGE.
  • The following haul element observed attribute should be N when other_event attribute event_code is reported: BAG, BULKDISC.

v2.9 [2022-09-01]

• Buisness rules governing the absence of values for the datetime, longitude, and latitude attributes on haul elements and discard_event elements have been changed to be consistent. The API Constraints have been adjusted to accept the following scenarios:
  • datetime, longitude, and latitude attributes may all be null
  • when longitude is not null then latitude must not be null (and visa versa)
  • datetime value is allowed with null longitude and latitude
  • datetime must not be null when values exist for longitude and latitude
• species_common_itis is no longer allowed as an attribute of a discard_events element.

v2.8 [2022-04-01] Changes in this version apply to /mul_detail method (groundfish fishery)

• New trip-level data element, all_effort_confirmed is required.
• New trip-level elements sail_datetime and land_datetime representing the timestamp (date and time) that the trip begins and ends from the video review.
• The trip-level elements date_sail, date_land, total_hauls, reviewed_hauls, and observed have been deprecated and will not be accepted in reviews of FY22 trips.
• New haul-level reviewer_id element of each haul object, required.
• Added grade_code as a required element of each discard object.
• species_common_itis has been deprecated and will no longer be read by the api nor written to the database.
• The following species_code_itis has been deprecated and may not be used for FY22 trip reviews 164730 (HAKE, RED).
• The following species_code_itis code for FISH, NK has been changed to 914179. The code 161030 has been deprecated and may not be used for FY22 trip reviews.
• The following species_code_itis code for TURTLE, NK has been changed to 948936. The code 173749 has been deprecated and may not be used for FY22 trip reviews.
• New condition requires that weight must be NULL when weight_determined_by is LENGTH for FY22 trip reviews.
• The other_events element event_category has been deprecated and may not be used for FY22 trip reviews.
• The following event_code codes have been deprecated and may not be used for FY22 trip reviews:
  • NIGHTIMPAIR (NIGHTTIME SYTEM IMAGE IMPAIRMENT)
  • CAMBLOCK (CAMERA BLOCKING)
  • MEASVIS (MEASURING SURFACE VISIBILITY)
• The following event_code codes have been added for FY22 trip reviews:
  • CAMDAMAGE (OPERATIONS INDUCED CAMERA DAMAGE)
  • LIGHTORGLARE (POOR LIGHTING/SUN GLARE)
• Re-submissions no longer require review_id.
• review_id will not be returned in the api response for trip reviews after FY2021.
• All error responses will now include the boolean error attribute (previously certain responses used status attribute).
• All error responses will now include the message attribute (previously certain responses used error to contain the message to be displayed to the user).
• The error response status attribute has been deprecated; the error attribute should be used instead.

v2.7 [2022-03-04] Changes in this version apply to only /hrg_detail method (herring fishery)

• The trip-level data element, pair_trawl_indicator has been deprecated and will not be accepted in reviews of FY22 trips.
• New haul-level data element, pair_trawl is required of each haul object.

v2.6 [2022-03-01] Changes in this version apply to only /hrg_detail method (herring fishery)

• New trip-level data element, all_effort_confirmed is required.
• New trip-level elements sail_datetime and land_datetime representing the timestamp (date and time) that the trip begins and ends from the video review.
• The trip-level elements date_sail, date_land, total_hauls, reviewed_hauls, and observed have been deprecated and will not be accepted in reviews of FY22 trips.
• New haul-level reviewer_id element of each haul object, required.
• Added grade_code as a required element of each discard object using the /hrg_detail method; the only allowed value is "01" in this fishery.
• species_common_itis has been deprecated and will no longer be read by the api nor written to the database.
• The following species_code_itis has been deprecated and may not be used for FY22 trip reviews 164730 (HAKE, RED).
• The following species_code_itis code for FISH, NK has been changed to 914179. The code 161030 has been deprecated and may not be used for FY22 trip reviews.
• The following species_code_itis code for TURTLE, NK has been changed to 948936. The code 173749 has been deprecated and may not be used for FY22 trip reviews.
• New condition requires that weight must be NULL when length is NOT NULL for reviews of FY22 trips.
• delayed_catch_process is now a required element for haul objects using the /hrg_detail method; the only allowed value is "N" in this fishery.
• The other_events element event_category has been deprecated and may not be used for FY22 trip reviews.
• The following event_code codes have been deprecated and may not be used for FY22 trip reviews:
  • NIGHTIMPAIR (NIGHTTIME SYTEM IMAGE IMPAIRMENT)
  • CAMBLOCK (CAMERA BLOCKING)
  • MEASVIS (MEASURING SURFACE VISIBILITY)
• The following event_code codes have been added for FY22 trip reviews:
  • CAMDAMAGE (OPERATIONS INDUCED CAMERA DAMAGE)
  • LIGHTORGLARE (POOR LIGHTING/SUN GLARE)
• Re-submissions no longer require review_id.
• review_id will not be returned in the api response for trip reviews after FY2021.
• All error responses will now include the boolean error attribute (previously certain responses used status attribute).
• All error responses will now include the message attribute (previously certain responses used error to contain the message to be displayed to the user).
• The error response status attribute has been deprecated; the error attribute should be used instead.

FY2021

v2.5 [2021-07-12]

• The data elements date_sail and date_land are no longer required. A review is matched to a trip using the vessel_permit_numer and evtr_num and all datetime elements defining each haul must fall between the SAIL_DATE and LAND_DATE on record in the NEMIS database.

v2.4 [2021-04-13]

• Valid codes for event_reason were added for hrg_detail.

v2.3 [2021-04-13]

• Added link to NEMIS endpoint in the description.

v2.2 [2021-04-12]

• Correct typo (no delimiter on species_itis enums).

v2.1 [2021-04-07]

• Remove RELEASE from /mul_detail event_code enum, corrected species_common_itis enum, corrected event_code (from OFO to OOI).

v2.0 [2021-03-11]

• API Specification has been updated for FY2021.

FY2020

v1.16 [2020-12-15]

• More descriptive response, including a local_timestamp and haul_id is returned on 406 Not Acceptable errors. The json schema for this return has been updated and example provided in the openapi.json specification file.

v1.15 [2020-08-06]

• Haul elements without all required attributes are now accepted when observed does not equal 'Y'. This supersedes the definition in v1.13 where the attribute amount_reviewed value controlled enforcement of haul element requirements; going forward only the value of observed will be used to apply the rules defined in the Haul element guidance.

v1.14 [2020-07-27]

• Method /trips has been changed to include 100 items per page of results (up from 30 results).

v1.13 [2020-07-17]

• Haul element attributes set_start_datetime, set_start_lat, set_start_lon, set_end_datetime, set_end_lat, and set_end_lon are now allowed (optional) when gear_category = 090 (Trawl) and a comment is included explaining why the haul should be marked amount_reviewed = 'FULL' without these haul element attributes.
• Haul element attribute amount_reviewed allowed values no longer includes "INCOMPLETE". See updated Haul element guidance for clarification.

v1.12 [2020-07-10]

• Haul element attributes set_start_datetime, set_start_lat, and set_start_lon are now allowed (optional) when gear_category = 700 (Jig and Handline).
• Haul elements without all required attributes (as defined in Haul element guidance) are now accepted when amount_reviewed does not equal FULL.
• Haul element attribute amount_reviewed allowed values now includes "INCOMPLETE" to signify missing video that does not impact the haul element attribute observed (amount_reviewed must be FULL or INCOMPLETE if observed is Y)
• Additional guidance for defining the timestamp for an other_event element with attribute event_duration provided in API Instructions Event durations.

v1.11 [2020-06-23]

• The server url for this api has been changed. The old url has been depreicated and calls to the old url will be forwarded to the new url for a short time.
• The acceptable value list for "discard_events" disposition has been reduced, and is now limited to ["031","043","052","099","900"] for /mul_detail. See API Object Reference for disposition attribute.
• An error was found and corrected in the reference for species_code_itis code for "SEAL, NK" (whitespace inadvertently included in code).

v1.10 [2020-05-12]

• New attribute "other_event" event_duration for /mul_detail will be accepted for recording the length of time that events occurred. Note the format of values must comply with ISO8601 standard. See Event durations for how to use this attribute.

v1.9 [2020-04-17]

• report_id attribute has been deprecated and replaced with review_id. API responses documentation have been corrected.

v1.8 [2020-04-06]

• New attribute "other_event" event_duration for /hrg_detail will be accepted for recording the length of time that certain events occurred. Note the format of values must comply with ISO8601 standard.

v1.7 [2020-03-31]

• Documentation of gear_category for /hrg_detail method has been corrected (Removed "110")
• Haul elements set_start, set_end, haulback_start, haulback_end required, dependent upon gear_category which aligns the API with VTR and Reviewer Guidance. See Haul Element Definitions documentation.

v1.6 [2020-03-19]

• Added "RCA" (Remote Camera Access) to event_code

v1.5 [2020-03-18]

• Added "DOGFISH, NK" to species_code_itis and species_common_itis

v1.4 [2020-03-17]

• Removed "SKATE, NK" from species_code_itis and species_common_itis
• Removed "FLOUNDER, NK" and "GROUNDFISH, NK" from species_code_itis and species_common_itis (use "FISH, NK")
• Removed "FLOUNDER, LEFTEYE, NK" from species_code_itis and species_common_itis
• Removed "HAKE, NK" and "HAKE, RED (LING)" from species_code_itis and species_common_itis
• Added "HAKE, RED/WHITE MIX" to species_code_itis and species_common_itis
• Renamed species_code_itis 166774 from "REDFISH, NK (OCEAN PERCH)" to "REDFISH, ACADIAN" (species_common_itis)

v1.3 [2020-03-10]

• Split /em_detail into two, fishery-specific methods /mul_detail and /hrg_detail

v1.1 [2020-03-02]

• Removed haul image_quality and image_quality_reason
• Haul gear_category codes have been added by ACCSP
• Haul detect_method has been added (Herring-specific field)
• Discard weight_determined_by codes have been updated to match observer db
• Added some new codes to discard event_code
• Added "FLOUNDER, LEFTEYE, NK" to species_code_itis and species_common_itis
• Removed scallop codes and "HAKE, RED/WHITE MIX" from species_code_itis and species_common_itis
• haul_id is now required for all discard_event objects

v1.0 [2019-12-20]

• Initial publication