The processor_user_info XML document is returned when authenticating to the eLandings web services. It has the following elements.
Messages
The messages element provides error and information messages about requests that are submitted to the eLandings server. It will be omitted from user data XML that is returned from a successful authentication call to eLandings. The messages element may contain any number of message elements.
Data Type |
Since Schema Version |
Oracle Database Data Definition |
Values |
---|---|---|---|
text |
1.0 |
N/A |
The message text can be of arbitrary length, and can include data values that caused the problem to be reported. Typically the text length will not exceed 265 characters. |
The message element has four attributes
- The msgid attribute provides a unique identifier for the message, which can be used to lookup further information on the eLandings website.
Data Type
Since Schema Version
Oracle Database Data Definition
Values
integer
1.0
NUMBER(10,0)
Msg IDs will typically be between 1000 and 99,999. Msg IDs can be looked up on the eLandings website
- The severity_code attribute identifies the severity of the message
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
N/A
The severity code values and translations are:
S - System Error
E - Error
W - Warning
I - Information - The severity_desc attribute is the translation of the severity code.
- The prefix attribute is a message prefix that relates the message to particular lines or items in the XML document.
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
N/A
The prefix is not applicable to all messages. Where used it has values such as "Line x, Grading/pricing line y".
Schema Version
The schema version data element allows the software to know the version of the schema for which an XML file was generated. If the schema version element is not provided that indicates the version is 1.0, the original groundfish release production schema. The contents of the schema version element corresponds to the version attribute in the <xs:schema> element of the schema, the top level element of the schema definition.
Note that this is NOT the version attribute in the <xml> element that contains the schema definition. That attribute defines the version of XML, as specified by the W3C consortium.
Processor_user
The processor_user element contains data about the user that has been authenticated.
- userid
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
VARCHAR2(32)
Userid identifies users of the system. Rules for userids are documented by the eLandings business rules
- password
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
VARCHAR2(16)
Password provides users with an authentication token to use when identifying themselves to the system. Rules for passwords are documented by the eLandings business rules. In addition, the password cannot be the same as the userid.
- user_name
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
VARCHAR2(32)
User name is the name the user provided during registration.]
- company
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
VARCHAR2(32)
Company is the name the user provided during registration.]
- parent_company
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
VARCHAR2(32)
Parent company is the name the user provided during registration, but is not required.]
- phone
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
VARCHAR2(32)
Phone is the phone number the user provided during registration. Rules for phone numbers are documented by the eLandings business rules
- fax
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
VARCHAR2(32)
Fax is the fax phone number the user provided during registration. Rules for fax phone numbers are documented by the eLandings business rules
- email
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
VARCHAR2(120)
Email is the email address the user provided during registration.
- proc_code
The proc_code element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services. - federal_processor_number
The federal_processor_number element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services. - registered_crab_receiver
The registered_crab_receiver element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services. - default_operation_id
- security_question
The security_question element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services. - secret_answer
The secret_answer element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services. - disabled
Data Type
Since Schema Version
Oracle Database Data Definition
Values
boolean
1.0
CHAR(1)
Disabled indicates whether or not the user is able to login. Value will be TRUE or FALSE.
- limited
Data Type
Since Schema Version
Oracle Database Data Definition
Values
boolean
1.0
CHAR(1)
Limited indicates whether the user has access to all reports for their operation, or only those that they have created. Value will be TRUE or FALSE.
- city
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
VARCHAR2(50)
City is the city name the user provided during registration.
- state
Data Type
Since Schema Version
Oracle Database Data Definition
Values
text
1.0
CHAR(2)
State is the state abbreviation the user provided during registration.
- num_decimals_for_weight
Data Type
Since Schema Version
Oracle Database Data Definition
Values
integer
1.0
NUMBER(2,0)
Number of decimals for weight is the number of decimal places that will be displayed for weight values when the user views them on eLandings. Weights with less than the specified number of decimal places will be displayed with zeros. Weights with more than the specified number of decimal places will be displayed with the actual significant digits.
- num_decimals_for_price
- num_cfec_permit_lines
- num_ifq_permit_lines
- num_stat_area_ws_lines
- num_itemized_catch_lines
- num_grading_pricing_lines
- num_prod_report_lines
- num_discard_lines
- authorized_operation
- operation
- type_of_operation
- operation_name
- description
The description element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services. - proc_code
- federal_processor_number
- registered_buyer_number
- registered_crab_receiver
- regiestered_crab_receiver_number
- ipq_permit
- ipq_permit_number
- species
- port_of_landing
- vessel - m
- license_number - m
- primary_userid
- parent_operation_codes - m
- type_of_operation
- proc_code
- federal_processor_number
- registered_buyer_number
- registered_crab_receiver
- disabled
- size_grade_template
- species
- condition_code
- show_price
- disabled
- product_item_template
- product_code
- product_type
- size_grade
- price
- user_defined_alias - m
- limited
- admin
- disabled
- operation
- printed_document
- document_name
- printed_copy
- color
- label
- background
- block
- final_report_visibility
The final_report_visibility element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services. - schema_change_notify
- schema_version
- failed_login_attempts
- last_login_date
- last_successful_login_date