Vendor Technical Specifications: Appendix A

Southeast Electronic For-Hire Reporting Data Requirements and Look Up Lists

Appendix A:  Required data elements and format for charter/headboat logbook and Gulf declaration 
 

DATA ELEMENT

UNITS

USCG Vessel ID or State vessel ID

 

Vessel Name

 

Captain Name

 

  First Name

 

  Last Name

 

Start Port

 

Landing Location

 

Trip Start Date

 

Trip Start Time

24-hour clock

Trip End Date

 

Trip End Time

24-hour clock

Fishing Hours

hours

Primary Target Species

 

Primary Gear 

 

Species Caught on Trip

 

  Name

 

  Number Kept (by species)

 

  Number Released (by species)

 

Area Fished

 

  Latitude

degrees and minutes

  Longitude

degrees and minutes

Primary Fishing Depth

feet

Minimum Fishing Depth

feet

Maximum Fishing Depth

feet

Number of Anglers

 

Number of Paying Passengers

 

Number of Crew

 

Trip Fee

dollars

Fuel Used

gallons

Price of Fuel

dollars/gallon

 General Processing:

-Fields without a value provided by the permit holder should result in an error message and denial of submission.

-Any commas places in an entry field must be removed prior to transmission.

- Must have Date/Time stamp for message (UTC)

 

US Coast Guard Documentation Number or State Registration Number:  

Populated by vendor through account set-up. 

Autofill OK

 

Vessel Name

Populated by vendor through account set-up

Autofill OK

 

Captain’s First Name 

Type: Alpha

Valid Values: A-Z

 

Captain’s Last Name

 Type: Alpha

 Valid Values: A-Z

 

Start Port

Type: Numeric (5 digits)

Valid values: 0-9

Range checks:  See Appendix C

Note - This list will be added to over time.

Autofill OK

 

Landing Location

Type: Numeric (5 digits)

Valid values: 0-9

Range checks:  See Appendix C

Note - This list will be added to over time.

Autofill OK

 

Trip Start Date

Trip Start Month 

         Type: Numeric, 2 Digits

         Valid Values: 0-9

         Range Checks: 01 – 12

 

Trip Start Day 

         Type: Numeric, 2 Digits

         Valid Values: 0-9

         Range Checks: 01 – 31

 

Trip Start Year 

Type: Numeric, 4 Digits

         Valid Values: 0-9

         Range Checks: 2020-2030*   (*revise this in 10 years)   

 

Trip start Time

Trip Start Hour 

         Type:  Numeric, 2 Digits

         Valid Values:  0-9

         Range Checks: 00-23

 

Trip Start Minute 

         Type:  Numeric, 2 Digits

         Valid Values:  0-9

         Range Checks: 00-59

 

Time Zone

Type: Alphabetic

Valid values: AST, EST, CST

 

Trip End Date

Trip End Month 

         Type: Numeric, 2-Digits

         Valid Values: 0-9

         Range Checks: 01 – 12

 

Trip End Day 

         Type: Numeric, 2 Digits

         Valid Values: 0-9

         Range Checks: 01 – 31

 

Trip Start Year 

Type: Numeric, 4 Digits

         Valid Values: 0-9

         Range Checks: 2020-2030*   (*revise this in 10 years)

 

Trip End Time

Trip End Hour 

         Type:  Numeric, 2 Digits

         Valid Values:  0-9

         Range Checks: 00-23

 

Trip End Minute

         Type:  Numeric, 2 Digits

         Valid Values:  0-9

         Range Checks: 00-59

 

Time Zone

Type: Alphabetic

Valid values: AST, EST, CST

 

Number of Hours Fished

Type: Numeric, 2 Digits

Valid values: 0-9

Range checks: 00-999

 

Primary Target Species

Type: Numeric 6 digits (ITIS Species Number)

Valid values: A complete listing of ITIS (Integrated Taxonomic Information System) numbers are listed in Appendix C.

Vendor must collect this via

a.       Dropdown menu of species names for the SEFHIER program and/or

b.      Direct entry of the words (e.g. “GREATER AMBERJACK”)

In addition to collecting via “a” or “b” the vendor may allow direct entry of the ITIS Species Number

Range Checks:_ITIS numbers.  See Appendix C

 

Primary Gear Code

Type: Numeric, 2 or 3 Digits

Valid Values: As listed in Appendix C.  

Vendor must collect gear type via dropdown menu of gear type

 

Species Caught

Species Caught data will be comprised of comma delimited numbers which taken in groups of three (a triune) describe the ITIS species number, number of fish retained, and number of fish released. Users must be able to input an unlimited number of triunes of data.

 

Species Name

Vendor must collect this via:

a.      Dropdown menu of SEFHIER Species List, and/or

b.      Direct entry of the words (e.g. “GREATER AMBERJACK”),

In addition to collecting via “a” or “b” the vendor may allow direct entry of the ITIS Species Number

Data should be transmitted using ITIS Species Number

Valid values:  A complete listing of ITIS (Integrated Taxonomic Information System) numbers are listed in Appendix C.

 

Number Kept

Type: Numeric 3 digits

Valid values: 0-9

Range checks: 0-999

 

Number Released

Type: Numeric 3 digits

Valid values: 0-9

Range checks: 0-999

 

Primary Area Fished

Area Fished (AA ° BB’  CCC ° DD’)

The data represents a geographic coordinate defined by degrees and whole minutes of latitude and degrees and whole minutes of longitude.

·         AA represents whole degrees of latitude.

·         BB represents whole minutes of latitude.

·         CCC represents whole degrees of longitude.

·         DD represents whole degrees of latitude.

North latitude and East longitude degrees are expressed as positive numbers, South latitude and West longitude degrees are expressed as negative numbers.  Minutes are expressed as positive numbers regardless of their cardinal direction.

 

The expected format will be two numbers (either positive or negative), a space, two numbers, a space, three numbers (either positive or negative), a space, and two numbers.

 

Valid Values and Range Checks: Most Area Fished data will represent positions within the Gulf of Mexico or along the Atlantic seaboard, but theoretically, any valid latitude and longitude value from any position in the world should be accepted. Therefore:  

AA must be between -90 and 90

BB musts be between 00 and 59

CCC must be between -180 and 180

DD must be between 00 and 59

 Example: (26 30 –084 30) which translates to 26° 30’ North, 084° 30’ West.

 

Primary Fishing Depth

Type: Numeric, 4 Digits

Valid Values: 0-9

Range Checks: 0-9999

**Must be limited to within the range of minimum fishing depth and maximum fishing depth. 

 

Minimum Fishing Depth 

Type: Numeric, 4 Digits

Valid Values: 0-9

Range Checks: 0-9999

 

Maximum Fishing Depth

Type: Numeric, 4 Digits

Valid Values: 0-9

Range Checks: 0-9999

 

Number of Anglers

Type:  Numeric, 3 Digits

Valid Values:  0-9

Range Checks: 0-999

**Number of Anglers cannot exceed Number of Paying Passengers

 

Number of Paying Passengers

Type:  Numeric, 3 Digits

Valid Values:  0-9

Range Checks: 0-999

 

Number of Crew

Type:  Numeric, 2 Digits

Valid Values:  0-9

Range Checks: 0-10

 

Trip fee 

Type:  Numeric, 5 Digits (decimal point) 2 Digits

Valid Values:  0-9

Range Checks: 0-99999.99

(Vendors, auto populate the decimal before the last two numeric values, representing dollars and cents)

 

Fuel Used (gallons)

Type: Numeric 4 digits (decimal point) 1 digit

Valid Values:  0-9

Range Checks: 0000.0-9999.9

(Vendors, auto populate the decimal point before the last numeric values, representing the gallons of fuel used during the trip)

 

Price of Fuel per Gal

Valid Values:  0-9

Range Checks: 00.00 to 10.00

(Vendors, auto populate the decimal point before the last two numeric values, representing the price of fuel used during the trip)

 

Required data elements and format for the Gulf declaration

DATA ELEMENT

USCG Vessel ID or State vessel ID

Trip Activity

Trip Type

Landing Location

Trip Start Date

Trip Start Time

Trip End Date

Trip End Time

Gear Code*

*This field is optional for fishermen to answer on the declaration form.  The following text should precede this field: “The owner/operator of a for-hire vessel that has for-hire permit AND has a commercial reef fish permit, must answer the following question.”

General Processing:

-Fields without a value provided by the permit holder should result in an error message and denial of submission.

-Any commas places in an entry field must be removed prior to transmission.

-Must have Date/Time stamp for message (UTC)

-Vessels with a Gulf commercial reef fish permit must submit a Commercial Reef Fish declaration if on a commercial trip. 

 

US Coast Guard Documentation Number or State Registration Number:  

Populated by vendor through account set-up. 

Autofill OK

 

Trip Activity

Type: Alphabetic

Valid values: 

 

Description

Code

Commercial

C

For-Hire: Charter

A

For-Hire: Headboat

H

Recreational (private angler)

R

If they list a C or R then we do not need to collect anything other fields on this form.  The data will be sent with only the date and time stamp, and form name.  All other data fields need to populate with zeros or null values.

 

Trip Type

Type: Alphabetic

Valid values: 

 

Description

Code 

Intended Fishing Trip

 

Intended Non-Fishing Trip

 

 

Landing Location

Type: Numeric (5 digits)

Valid values: 0-9

Range checks:  See Appendix C

Note - This list will be added to over time.

Autofill OK

 

Trip Start Date

Trip Start Month 

         Type: Numeric, 2 Digits

         Valid Values: 0-9

         Range Checks: 01 – 12

 

Trip Start Day 

         Type: Numeric, 2 Digits

         Valid Values: 0-9

         Range Checks: 01 – 31

 

Trip Start Year 

Type: Numeric, 4 Digits

         Valid Values: 0-9

         Range Checks: 2020-2030*   (*revise this in 10 years)

        

Trip start Time

Trip Start Hour 

         Type:  Numeric, 2 Digits

         Valid Values:  0-9

         Range Checks: 00-23

 

Trip Start Minute 

         Type:  Numeric, 2 Digits

         Valid Values:  0-9

         Range Checks: 00-59

 

Time Zone

Type: Alphabetic

Valid values: AST, EST, CST

 

Trip End Date

Trip End Month 

         Type: Numeric, 2-Digits

         Valid Values: 0-9

         Range Checks: 01 – 12

 

Trip End Day 

         Type: Numeric, 2 Digits

         Valid Values: 0-9

         Range Checks: 01 – 31

 

Trip Start Year 

Type: Numeric, 4 Digits

         Valid Values: 0-9

         Range Checks: 2020-2030*   (*revise this in 10 years)

Trip End Time

Trip End Hour 

         Type:  Numeric, 2 Digits

         Valid Values:  0-9

         Range Checks: 00-23

 

Trip End Minute

         Type:  Numeric, 2 Digits

         Valid Values:  0-9

         Range Checks: 00-59

 

Time Zone

Type: Alphabetic

Valid values: AST, EST, CST

Primary Gear Code

Type: Numeric, 2 or 3 Digits

Valid Values: As listed in Appendix C.  

Vendor must collect gear type via dropdown menu of gear type

Last updated by Southeast Regional Office on June 23, 2020