Module edifact.d03a.retail.mREQDOC
ballerinax/edifact.d03a.retail.mREQDOC Ballerina library
1.0.1
Functions
fromEdiString
Isolated Function
function fromEdiString(string ediText) returns EDI_REQDOC_REQDOC|errorConvert EDI string to Ballerina EDI_REQDOC_REQDOC record.
Parameters
- ediText string - EDI string to be converted
Return Type
- EDI_REQDOC_REQDOC|error - Ballerina record or error
fromEdiStringWithSchema
Isolated Function
function fromEdiStringWithSchema(string ediText, EdiSchema schema) returns EDI_REQDOC_REQDOC|errorConvert EDI string to Ballerina EDI_REQDOC_REQDOC record with schema.
Return Type
- EDI_REQDOC_REQDOC|error - Ballerina record or error
getSchema
Isolated Function
Get the EDI schema.
headersFromEdiString
Isolated Function
function headersFromEdiString(string ediText) returns EDI_REQDOC_REQDOCHeaders|errorParse only the envelope header segments from the given EDI string.
Parameters
- ediText string - EDI string to parse
Return Type
- EDI_REQDOC_REQDOCHeaders|error - Parsed EDI_REQDOC_REQDOCHeaders record, or error if the headers are malformed
interchangeFromEdiString
Isolated Function
function interchangeFromEdiString(string ediText) returns EDI_REQDOC_REQDOCInterchange|errorParse the full envelope hierarchy from the given EDI string. A malformed transaction body becomes an error in that transaction's body field.
Parameters
- ediText string - EDI string to parse
Return Type
- EDI_REQDOC_REQDOCInterchange|error - Parsed EDI_REQDOC_REQDOCInterchange, or error if the envelope is malformed
interchangeToEdiString
Isolated Function
function interchangeToEdiString(EDI_REQDOC_REQDOCInterchange msg) returns string|errorSerialise a EDI_REQDOC_REQDOCInterchange into EDI text; the inverse of interchangeFromEdiString. A transaction whose body is an error is refused — filter or replace it before calling.
Parameters
- msg EDI_REQDOC_REQDOCInterchange - The interchange to serialise
toEdiString
Isolated Function
function toEdiString(EDI_REQDOC_REQDOC data) returns string|errorConvert Ballerina EDI_REQDOC_REQDOC record to EDI string.
Parameters
- data EDI_REQDOC_REQDOC - Ballerina record to be converted
toEdiStringWithSchema
Isolated Function
function toEdiStringWithSchema(EDI_REQDOC_REQDOC data, EdiSchema ediSchema) returns string|errorConvert Ballerina EDI_REQDOC_REQDOC record to EDI string with schema.
transformFromEdiString
Isolated Function
Convert EDI string to Ballerina EDI_REQDOC_REQDOC record.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - Ballerina record or error
transformHeadersFromEdiString
Isolated Function
Convert EDI string to the envelope headers of EDI_REQDOC_REQDOC. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - EDI_REQDOC_REQDOCHeaders record boxed as anydata, or error
transformInterchangeFromEdiString
Isolated Function
Convert EDI string to a EDI_REQDOC_REQDOCInterchange record. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- any|error - EDI_REQDOC_REQDOCInterchange record boxed as any, or error
transformInterchangeToEdiString
Isolated Function
Convert a EDI_REQDOC_REQDOCInterchange record to EDI string.
Parameters
- content any - EDI_REQDOC_REQDOCInterchange record boxed as any
transformToEdiString
Isolated Function
Convert Ballerina EDI_REQDOC_REQDOC record to EDI string.
Parameters
- content anydata - Ballerina record to be converted
Records
edifact.d03a.retail.mREQDOC: Additional_product_id_Type
Closed record
Fields
- code string(default "PIA") -
- PRODUCT_IDENTIFIER_CODE_QUALIFIER? string -
- ITEM_NUMBER_IDENTIFICATION? ITEM_NUMBER_IDENTIFICATION_GType? -
- ITEM_NUMBER_IDENTIFICATION_2? ITEM_NUMBER_IDENTIFICATION_2_GType? -
- ITEM_NUMBER_IDENTIFICATION_3? ITEM_NUMBER_IDENTIFICATION_3_GType? -
- ITEM_NUMBER_IDENTIFICATION_4? ITEM_NUMBER_IDENTIFICATION_4_GType? -
- ITEM_NUMBER_IDENTIFICATION_5? ITEM_NUMBER_IDENTIFICATION_5_GType? -
edifact.d03a.retail.mREQDOC: Beginning_of_message_Type
Closed record
Fields
- code string(default "BGM") -
- DOCUMENT_MESSAGE_NAME? DOCUMENT_MESSAGE_NAME_GType? -
- DOCUMENT_MESSAGE_IDENTIFICATION? DOCUMENT_MESSAGE_IDENTIFICATION_GType? -
- MESSAGE_FUNCTION_CODE? string -
- RESPONSE_TYPE_CODE? string -
edifact.d03a.retail.mREQDOC: COMMUNICATION_CONTACT_GType
Closed record
Fields
- Communication_address_identifier string -
- Communication_address_code_qualifier string -
edifact.d03a.retail.mREQDOC: Communication_contact_Type
Closed record
Fields
- code string(default "COM") -
- COMMUNICATION_CONTACT COMMUNICATION_CONTACT_GType[](default []) -
edifact.d03a.retail.mREQDOC: Contact_information_Type
Closed record
Fields
- code string(default "CTA") -
- CONTACT_FUNCTION_CODE? string -
- DEPARTMENT_OR_EMPLOYEE_DETAILS? DEPARTMENT_OR_EMPLOYEE_DETAILS_GType? -
edifact.d03a.retail.mREQDOC: COUNTRY_SUB_ENTITY_DETAILS_GType
Closed record
Fields
- Country_sub_entity_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Country_sub_entity_name? string -
edifact.d03a.retail.mREQDOC: Date_and_time_GType
Closed record
Fields
- date string -
- time string -
edifact.d03a.retail.mREQDOC: DATE_TIME_PERIOD_GType
Closed record
Fields
- Date_or_time_or_period? string -
- Date_or_time_or_period_text? string -
- Date_or_time_or_period_format_code? string -
edifact.d03a.retail.mREQDOC: Date_time_period_Type
Closed record
Fields
- code string(default "DTM") -
- DATE_TIME_PERIOD? DATE_TIME_PERIOD_GType? -
edifact.d03a.retail.mREQDOC: DEPARTMENT_OR_EMPLOYEE_DETAILS_GType
Closed record
Fields
- Department_or_employee_name_code? string -
- Department_or_employee_name? string -
edifact.d03a.retail.mREQDOC: DOCUMENT_MESSAGE_DETAILS_GType
Closed record
Fields
- Document_identifier? string -
- Document_status_code? string -
- Document_source_description? string -
- Language_name_code? string -
- Version_identifier? string -
- Revision_identifier? string -
edifact.d03a.retail.mREQDOC: Document_message_details_Type
Closed record
Fields
- code string(default "DOC") -
- DOCUMENT_MESSAGE_NAME? DOCUMENT_MESSAGE_NAME_GType? -
- DOCUMENT_MESSAGE_DETAILS? DOCUMENT_MESSAGE_DETAILS_GType? -
- COMMUNICATION_MEDIUM_TYPE_CODE? string -
- DOCUMENT_COPIES_REQUIRED_QUANTITY? int? -
- DOCUMENT_ORIGINALS_REQUIRED_QUANTITY? int? -
edifact.d03a.retail.mREQDOC: DOCUMENT_MESSAGE_IDENTIFICATION_GType
Closed record
Fields
- Document_identifier? string -
- Version_identifier? string -
- Revision_identifier? string -
edifact.d03a.retail.mREQDOC: DOCUMENT_MESSAGE_NAME_GType
Closed record
Fields
- Document_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Document_name? string -
edifact.d03a.retail.mREQDOC: EDI_REQDOC_REQDOC
Closed record
Fields
- Beginning_of_message Beginning_of_message_Type -
- Document_message_details Document_message_details_Type -
- Date_time_period Date_time_period_Type[](default []) -
- Free_text Free_text_Type[](default []) -
- group_1 Group_1_GType[](default []) -
- group_2 Group_2_GType[](default []) -
- group_4 Group_4_GType[](default []) -
edifact.d03a.retail.mREQDOC: EDI_REQDOC_REQDOCHeaders
Closed record
Envelope headers of a EDI_REQDOC_REQDOC interchange.
Fields
- interchange EDI_REQDOC_REQDOCInterchangeHeader - Interchange header
- 'transaction EDI_REQDOC_REQDOCTransactionHeader - Transaction header
edifact.d03a.retail.mREQDOC: EDI_REQDOC_REQDOCInterchange
Closed record
A parsed EDI_REQDOC_REQDOC interchange with its full envelope hierarchy.
Fields
- interchangeHeader EDI_REQDOC_REQDOCInterchangeHeader - Interchange header segment
- transactions EDI_REQDOC_REQDOCTransaction[] - Transactions in the interchange
- interchangeTrailer EDI_REQDOC_REQDOCInterchangeTrailer - Interchange trailer segment
edifact.d03a.retail.mREQDOC: EDI_REQDOC_REQDOCInterchangeHeader
Closed record
Fields
- interchange_header Interchange_header_Type -
edifact.d03a.retail.mREQDOC: EDI_REQDOC_REQDOCInterchangeTrailer
Closed record
Fields
- interchange_trailer Interchange_trailer_Type -
edifact.d03a.retail.mREQDOC: EDI_REQDOC_REQDOCTransaction
Closed record
A single transaction within a EDI_REQDOC_REQDOC interchange.
Fields
- transactionHeader EDI_REQDOC_REQDOCTransactionHeader - Transaction header segment
- body EDI_REQDOC_REQDOC|error - Parsed EDI_REQDOC_REQDOC body, or the parse error when the body is malformed
- transactionTrailer EDI_REQDOC_REQDOCTransactionTrailer - Transaction trailer segment
edifact.d03a.retail.mREQDOC: EDI_REQDOC_REQDOCTransactionHeader
Closed record
Fields
- Message_header Message_header_Type -
edifact.d03a.retail.mREQDOC: EDI_REQDOC_REQDOCTransactionTrailer
Closed record
Fields
- Message_trailer Message_trailer_Type -
edifact.d03a.retail.mREQDOC: Free_text_Type
Closed record
Fields
- code string(default "FTX") -
- TEXT_SUBJECT_CODE_QUALIFIER? string -
- FREE_TEXT_FUNCTION_CODE? string -
- TEXT_REFERENCE? TEXT_REFERENCE_GType? -
- TEXT_LITERAL? TEXT_LITERAL_GType? -
- LANGUAGE_NAME_CODE? string -
- FREE_TEXT_FORMAT_CODE? string -
edifact.d03a.retail.mREQDOC: Group_1_GType
Closed record
Fields
- Reference Reference_Type -
- Date_time_period Date_time_period_Type[](default []) -
edifact.d03a.retail.mREQDOC: Group_2_GType
Closed record
Fields
- Name_and_address Name_and_address_Type -
- Place_location_identification Place_location_identification_Type[](default []) -
- group_3 Group_3_GType[](default []) -
edifact.d03a.retail.mREQDOC: Group_3_GType
Closed record
Fields
- Contact_information Contact_information_Type -
- Communication_contact Communication_contact_Type[](default []) -
edifact.d03a.retail.mREQDOC: Group_4_GType
Closed record
Fields
- Line_item Line_item_Type -
- Processing_information Processing_information_Type[](default []) -
- Date_time_period Date_time_period_Type[](default []) -
- Additional_product_id Additional_product_id_Type[](default []) -
- Item_description Item_description_Type[](default []) -
- Measurements Measurements_Type[](default []) -
- group_5 Group_5_GType[](default []) -
- group_6 Group_6_GType[](default []) -
edifact.d03a.retail.mREQDOC: Group_5_GType
Closed record
Fields
- Reference Reference_Type -
- Date_time_period Date_time_period_Type[](default []) -
edifact.d03a.retail.mREQDOC: Group_6_GType
Closed record
Fields
- Name_and_address Name_and_address_Type -
- Place_location_identification Place_location_identification_Type[](default []) -
- group_7 Group_7_GType[](default []) -
edifact.d03a.retail.mREQDOC: Group_7_GType
Closed record
Fields
- Contact_information Contact_information_Type -
- Communication_contact Communication_contact_Type[](default []) -
edifact.d03a.retail.mREQDOC: Interchange_header_Type
Closed record
Fields
- code string(default "UNB") -
- syntax_identifier Syntax_identifier_GType -
- sender Sender_GType -
- recipient Recipient_GType -
- date_and_time Date_and_time_GType -
- control_reference string -
- recipient_reference_password? Recipient_reference_password_GType? -
- application_reference? string -
- processing_priority_code? string -
- acknowledgement_request? string -
- communications_agreement_id? string -
- test_indicator? string -
edifact.d03a.retail.mREQDOC: Interchange_trailer_Type
Closed record
Fields
- code string(default "UNZ") -
- interchange_control_count int -
- interchange_control_reference string -
edifact.d03a.retail.mREQDOC: ITEM_CHARACTERISTIC_GType
Closed record
Fields
- Item_characteristic_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: ITEM_DESCRIPTION_GType
Closed record
Fields
- Item_description_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Item_description? string -
- Item_description_4? string -
- Language_name_code? string -
edifact.d03a.retail.mREQDOC: Item_description_Type
Closed record
Fields
- code string(default "IMD") -
- DESCRIPTION_FORMAT_CODE? string -
- ITEM_CHARACTERISTIC? ITEM_CHARACTERISTIC_GType? -
- ITEM_DESCRIPTION? ITEM_DESCRIPTION_GType? -
- SURFACE_OR_LAYER_CODE? string -
edifact.d03a.retail.mREQDOC: ITEM_NUMBER_IDENTIFICATION_2_GType
Closed record
Fields
- Item_identifier? string -
- Item_type_identification_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: ITEM_NUMBER_IDENTIFICATION_3_GType
Closed record
Fields
- Item_identifier? string -
- Item_type_identification_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: ITEM_NUMBER_IDENTIFICATION_4_GType
Closed record
Fields
- Item_identifier? string -
- Item_type_identification_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: ITEM_NUMBER_IDENTIFICATION_5_GType
Closed record
Fields
- Item_identifier? string -
- Item_type_identification_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: ITEM_NUMBER_IDENTIFICATION_GType
Closed record
Fields
- Item_identifier? string -
- Item_type_identification_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: Line_item_Type
Closed record
Fields
- code string(default "LIN") -
- LINE_ITEM_IDENTIFIER? string -
- ITEM_NUMBER_IDENTIFICATION? ITEM_NUMBER_IDENTIFICATION_GType? -
- SUB_LINE_INFORMATION? SUB_LINE_INFORMATION_GType? -
- CONFIGURATION_LEVEL_NUMBER? int? -
- CONFIGURATION_OPERATION_CODE? string -
edifact.d03a.retail.mREQDOC: LOCATION_IDENTIFICATION_GType
Closed record
Fields
- Location_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Location_name? string -
edifact.d03a.retail.mREQDOC: MEASUREMENT_DETAILS_GType
Closed record
Fields
- Measured_attribute_code? string -
- Measurement_significance_code? string -
- Non_discrete_measurement_name_code? string -
- Non_discrete_measurement_name? string -
edifact.d03a.retail.mREQDOC: Measurements_Type
Closed record
Fields
- code string(default "MEA") -
- MEASUREMENT_PURPOSE_CODE_QUALIFIER? string -
- MEASUREMENT_DETAILS? MEASUREMENT_DETAILS_GType? -
- VALUE_RANGE? VALUE_RANGE_GType? -
- SURFACE_OR_LAYER_CODE? string -
edifact.d03a.retail.mREQDOC: Message_header_Type
Closed record
Fields
- code string(default "UNH") -
- message_reference_number string -
- message_identifier Message_identifier_GType -
edifact.d03a.retail.mREQDOC: Message_identifier_GType
Closed record
Fields
- message_type string -
- message_version_number string -
- message_release_number string -
- controlling_agency string -
- association_assigned_code? string -
- code_list_directory_version? string -
- message_type_sub_function? string -
edifact.d03a.retail.mREQDOC: Message_trailer_Type
Closed record
Fields
- code string(default "UNT") -
- number_of_segments int -
- message_reference_number string -
edifact.d03a.retail.mREQDOC: NAME_AND_ADDRESS_GType
Closed record
Fields
- Name_and_address_description string -
- Name_and_address_description_1? string -
- Name_and_address_description_2? string -
- Name_and_address_description_3? string -
- Name_and_address_description_4? string -
edifact.d03a.retail.mREQDOC: Name_and_address_Type
Closed record
Fields
- code string(default "NAD") -
- PARTY_FUNCTION_CODE_QUALIFIER? string -
- PARTY_IDENTIFICATION_DETAILS? PARTY_IDENTIFICATION_DETAILS_GType? -
- NAME_AND_ADDRESS? NAME_AND_ADDRESS_GType? -
- PARTY_NAME? PARTY_NAME_GType? -
- STREET? STREET_GType? -
- CITY_NAME? string -
- COUNTRY_SUB_ENTITY_DETAILS? COUNTRY_SUB_ENTITY_DETAILS_GType? -
- POSTAL_IDENTIFICATION_CODE? string -
- COUNTRY_NAME_CODE? string -
edifact.d03a.retail.mREQDOC: PARTY_IDENTIFICATION_DETAILS_GType
Closed record
Fields
- Party_identifier string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: PARTY_NAME_GType
Closed record
Fields
- Party_name string -
- Party_name_1? string -
- Party_name_2? string -
- Party_name_3? string -
- Party_name_4? string -
- Party_name_format_code? string -
edifact.d03a.retail.mREQDOC: Place_location_identification_Type
Closed record
Fields
- code string(default "LOC") -
- LOCATION_FUNCTION_CODE_QUALIFIER? string -
- LOCATION_IDENTIFICATION? LOCATION_IDENTIFICATION_GType? -
- RELATED_LOCATION_ONE_IDENTIFICATION? RELATED_LOCATION_ONE_IDENTIFICATION_GType? -
- RELATED_LOCATION_TWO_IDENTIFICATION? RELATED_LOCATION_TWO_IDENTIFICATION_GType? -
- RELATION_CODE? string -
edifact.d03a.retail.mREQDOC: PROCESSING_INDICATOR_GType
Closed record
Fields
- Processing_indicator_description_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Processing_indicator_description? string -
edifact.d03a.retail.mREQDOC: Processing_information_Type
Closed record
Fields
- code string(default "GEI") -
- PROCESSING_INFORMATION_CODE_QUALIFIER? string -
- PROCESSING_INDICATOR? PROCESSING_INDICATOR_GType? -
- PROCESS_TYPE_DESCRIPTION_CODE? string -
edifact.d03a.retail.mREQDOC: Recipient_GType
Closed record
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.retail.mREQDOC: Recipient_reference_password_GType
Closed record
Fields
- reference_password? string -
- qualifier? string -
edifact.d03a.retail.mREQDOC: REFERENCE_GType
Closed record
Fields
- Reference_code_qualifier string -
- Reference_identifier? string -
- Document_line_identifier? string -
- Reference_version_identifier? string -
- Revision_identifier? string -
edifact.d03a.retail.mREQDOC: Reference_Type
Closed record
Fields
- code string(default "RFF") -
- REFERENCE? REFERENCE_GType? -
edifact.d03a.retail.mREQDOC: RELATED_LOCATION_ONE_IDENTIFICATION_GType
Closed record
Fields
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: RELATED_LOCATION_TWO_IDENTIFICATION_GType
Closed record
Fields
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: Sender_GType
Closed record
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.retail.mREQDOC: STREET_GType
Closed record
Fields
- Street_and_number_or_post_office_box_identifier string -
- Street_and_number_or_post_office_box_identifier_1? string -
- Street_and_number_or_post_office_box_identifier_2? string -
- Street_and_number_or_post_office_box_identifier_3? string -
edifact.d03a.retail.mREQDOC: SUB_LINE_INFORMATION_GType
Closed record
Fields
- Sub_line_indicator_code? string -
- Line_item_identifier? string -
edifact.d03a.retail.mREQDOC: Syntax_identifier_GType
Closed record
Fields
- syntax_id string -
- syntax_version string -
- service_code_list_directory_version? string -
- character_encoding? string -
edifact.d03a.retail.mREQDOC: TEXT_LITERAL_GType
Closed record
Fields
- Free_text string -
- Free_text_1? string -
- Free_text_2? string -
- Free_text_3? string -
- Free_text_4? string -
edifact.d03a.retail.mREQDOC: TEXT_REFERENCE_GType
Closed record
Fields
- Free_text_description_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mREQDOC: VALUE_RANGE_GType
Closed record
Fields
- Measurement_unit_code string -
- Measure? string -
- Range_minimum_quantity? int? -
- Range_maximum_quantity? int? -
- Significant_digits_quantity? int? -