Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

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.

  1. userid
  2. password
  3. user_name
  4. company
  5. parent_company - m
  6. phone
  7. fax
  8. email
  9. 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.
  10. 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.
  11. 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.
  12. default_operation_id
  13. 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.
  14. 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.
  15. disabled
  16. limited
  17. city
  18. state
  19. num_decimals_for_weight
  20. num_decimals_for_price
  21. num_cfec_permit_lines
  22. num_ifq_permit_lines
  23. num_stat_area_ws_lines
  24. num_itemized_catch_lines
  25. num_grading_pricing_lines
  26. num_prod_report_lines
  27. num_discard_lines
  28. authorized_operation
    1. operation
      1. type_of_operation
      2. operation_name
      3. description
        The description element is used internally by the eLandings system. It will not be seen in XML documents returned from the web services.
      4. proc_code
      5. federal_processor_number
      6. registered_buyer_number
      7. registered_crab_receiver
        1. regiestered_crab_receiver_number
        2. ipq_permit
          1. ipq_permit_number
          2. species
      8. port_of_landing
      9. vessel - m
      10. license_number - m
      11. primary_userid
      12. parent_operation_codes - m
        1. type_of_operation
        2. proc_code
        3. federal_processor_number
        4. registered_buyer_number
        5. registered_crab_receiver
      13. disabled
      14. size_grade_template
        1. species
        2. condition_code
        3. show_price
        4. disabled
        5. product_item_template
          1. product_code
          2. product_type
          3. size_grade
          4. price
          5. user_defined_alias - m
    2. limited
    3. admin
    4. disabled
  29. printed_document
    1. document_name
    2. printed_copy
      1. color
      2. label
      3. background
      4. block
  30. 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.
  31. schema_change_notify
  32. schema_version
  33. failed_login_attempts
  34. last_login_date
  35. last_successful_login_date
  • No labels