Note: There is a newer version (1.0.1) of this package available. Click here to view docs for the latest version.
Module edifact.d03a.retail.mPRODEX
ballerinax/edifact.d03a.retail.mPRODEX Ballerina library
1.0.0
Functions
fromEdiString
Isolated Function
function fromEdiString(string ediText) returns EDI_PRODEX_PRODEX|errorConvert EDI string to Ballerina EDI_PRODEX_PRODEX record.
Parameters
- ediText string - EDI string to be converted
Return Type
- EDI_PRODEX_PRODEX|error - Ballerina record or error
fromEdiStringWithSchema
Isolated Function
function fromEdiStringWithSchema(string ediText, EdiSchema schema) returns EDI_PRODEX_PRODEX|errorConvert EDI string to Ballerina EDI_PRODEX_PRODEX record with schema.
Return Type
- EDI_PRODEX_PRODEX|error - Ballerina record or error
getSchema
Isolated Function
Get the EDI schema.
headersFromEdiString
Isolated Function
function headersFromEdiString(string ediText) returns EDI_PRODEX_PRODEXHeaders|errorParse only the envelope header segments from the given EDI string.
Parameters
- ediText string - EDI string to parse
Return Type
- EDI_PRODEX_PRODEXHeaders|error - Parsed EDI_PRODEX_PRODEXHeaders record, or error if the headers are malformed
interchangeFromEdiString
Isolated Function
function interchangeFromEdiString(string ediText) returns EDI_PRODEX_PRODEXInterchange|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_PRODEX_PRODEXInterchange|error - Parsed EDI_PRODEX_PRODEXInterchange, or error if the envelope is malformed
interchangeToEdiString
Isolated Function
function interchangeToEdiString(EDI_PRODEX_PRODEXInterchange msg) returns string|errorSerialise a EDI_PRODEX_PRODEXInterchange 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_PRODEX_PRODEXInterchange - The interchange to serialise
toEdiString
Isolated Function
function toEdiString(EDI_PRODEX_PRODEX data) returns string|errorConvert Ballerina EDI_PRODEX_PRODEX record to EDI string.
Parameters
- data EDI_PRODEX_PRODEX - Ballerina record to be converted
toEdiStringWithSchema
Isolated Function
function toEdiStringWithSchema(EDI_PRODEX_PRODEX data, EdiSchema ediSchema) returns string|errorConvert Ballerina EDI_PRODEX_PRODEX record to EDI string with schema.
transformFromEdiString
Isolated Function
Convert EDI string to Ballerina EDI_PRODEX_PRODEX 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_PRODEX_PRODEX. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - EDI_PRODEX_PRODEXHeaders record boxed as anydata, or error
transformInterchangeFromEdiString
Isolated Function
Convert EDI string to a EDI_PRODEX_PRODEXInterchange record. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- any|error - EDI_PRODEX_PRODEXInterchange record boxed as any, or error
transformInterchangeToEdiString
Isolated Function
Convert a EDI_PRODEX_PRODEXInterchange record to EDI string.
Parameters
- content any - EDI_PRODEX_PRODEXInterchange record boxed as any
transformToEdiString
Isolated Function
Convert Ballerina EDI_PRODEX_PRODEX record to EDI string.
Parameters
- content anydata - Ballerina record to be converted
Records
edifact.d03a.retail.mPRODEX: 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.mPRODEX: CARRIER_GType
Closed record
Fields
- Carrier_identifier? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Carrier_name? string -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: Date_and_time_GType
Closed record
Fields
- date string -
- time string -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: Date_time_period_Type
Closed record
Fields
- code string(default "DTM") -
- DATE_TIME_PERIOD? DATE_TIME_PERIOD_GType? -
edifact.d03a.retail.mPRODEX: DOCUMENT_MESSAGE_IDENTIFICATION_GType
Closed record
Fields
- Document_identifier? string -
- Version_identifier? string -
- Revision_identifier? string -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: EDI_PRODEX_PRODEX
Closed record
Fields
- Beginning_of_message Beginning_of_message_Type -
- Date_time_period Date_time_period_Type[](default []) -
- Measurements Measurements_Type -
- Name_and_address Name_and_address_Type[](default []) -
- group_1 Group_1_GType[](default []) -
- group_2 Group_2_GType[](default []) -
edifact.d03a.retail.mPRODEX: EDI_PRODEX_PRODEXHeaders
Closed record
Envelope headers of a EDI_PRODEX_PRODEX interchange.
Fields
- interchange EDI_PRODEX_PRODEXInterchangeHeader - Interchange header
- 'transaction EDI_PRODEX_PRODEXTransactionHeader - Transaction header
edifact.d03a.retail.mPRODEX: EDI_PRODEX_PRODEXInterchange
Closed record
A parsed EDI_PRODEX_PRODEX interchange with its full envelope hierarchy.
Fields
- interchangeHeader EDI_PRODEX_PRODEXInterchangeHeader - Interchange header segment
- transactions EDI_PRODEX_PRODEXTransaction[] - Transactions in the interchange
- interchangeTrailer EDI_PRODEX_PRODEXInterchangeTrailer - Interchange trailer segment
edifact.d03a.retail.mPRODEX: EDI_PRODEX_PRODEXInterchangeHeader
Closed record
Fields
- interchange_header Interchange_header_Type -
edifact.d03a.retail.mPRODEX: EDI_PRODEX_PRODEXInterchangeTrailer
Closed record
Fields
- interchange_trailer Interchange_trailer_Type -
edifact.d03a.retail.mPRODEX: EDI_PRODEX_PRODEXTransaction
Closed record
A single transaction within a EDI_PRODEX_PRODEX interchange.
Fields
- transactionHeader EDI_PRODEX_PRODEXTransactionHeader - Transaction header segment
- body EDI_PRODEX_PRODEX|error - Parsed EDI_PRODEX_PRODEX body, or the parse error when the body is malformed
- transactionTrailer EDI_PRODEX_PRODEXTransactionTrailer - Transaction trailer segment
edifact.d03a.retail.mPRODEX: EDI_PRODEX_PRODEXTransactionHeader
Closed record
Fields
- Message_header Message_header_Type -
edifact.d03a.retail.mPRODEX: EDI_PRODEX_PRODEXTransactionTrailer
Closed record
Fields
- Message_trailer Message_trailer_Type -
edifact.d03a.retail.mPRODEX: EXCESS_TRANSPORTATION_INFORMATION_GType
Closed record
Fields
- Excess_transportation_reason_code string -
- Excess_transportation_responsibility_code string -
edifact.d03a.retail.mPRODEX: Group_1_GType
Closed record
Fields
- Reference Reference_Type -
- Date_time_period? Date_time_period_Type? -
edifact.d03a.retail.mPRODEX: Group_2_GType
Closed record
Fields
- Item_description Item_description_Type -
- Quantity Quantity_Type[](default []) -
- group_3 Group_3_GType[](default []) -
edifact.d03a.retail.mPRODEX: Group_3_GType
Closed record
Fields
- Line_item Line_item_Type -
- Processing_information Processing_information_Type[](default []) -
- Place_location_identification Place_location_identification_Type[](default []) -
- Date_time_period? Date_time_period_Type? -
- Measurements Measurements_Type[](default []) -
- Quantity Quantity_Type[](default []) -
- Transport_information Transport_information_Type[](default []) -
- group_4 Group_4_GType[](default []) -
edifact.d03a.retail.mPRODEX: Group_4_GType
Closed record
Fields
- Reference Reference_Type -
- Date_time_period? Date_time_period_Type? -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: Interchange_trailer_Type
Closed record
Fields
- code string(default "UNZ") -
- interchange_control_count int -
- interchange_control_reference string -
edifact.d03a.retail.mPRODEX: ITEM_CHARACTERISTIC_GType
Closed record
Fields
- Item_characteristic_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: 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.mPRODEX: 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.mPRODEX: 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.mPRODEX: 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.mPRODEX: 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.mPRODEX: 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.mPRODEX: Message_header_Type
Closed record
Fields
- code string(default "UNH") -
- message_reference_number string -
- message_identifier Message_identifier_GType -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: Message_trailer_Type
Closed record
Fields
- code string(default "UNT") -
- number_of_segments int -
- message_reference_number string -
edifact.d03a.retail.mPRODEX: MODE_OF_TRANSPORT_GType
Closed record
Fields
- Transport_mode_name_code? string -
- Transport_mode_name? string -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: 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.mPRODEX: PARTY_IDENTIFICATION_DETAILS_GType
Closed record
Fields
- Party_identifier string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: 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.mPRODEX: 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.mPRODEX: 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.mPRODEX: QUANTITY_DETAILS_GType
Closed record
Fields
- Quantity_type_code_qualifier string -
- Quantity string -
- Measurement_unit_code? string -
edifact.d03a.retail.mPRODEX: Quantity_Type
Closed record
Fields
- code string(default "QTY") -
- QUANTITY_DETAILS? QUANTITY_DETAILS_GType? -
edifact.d03a.retail.mPRODEX: Recipient_GType
Closed record
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.retail.mPRODEX: Recipient_reference_password_GType
Closed record
Fields
- reference_password? string -
- qualifier? string -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: Reference_Type
Closed record
Fields
- code string(default "RFF") -
- REFERENCE? REFERENCE_GType? -
edifact.d03a.retail.mPRODEX: RELATED_LOCATION_ONE_IDENTIFICATION_GType
Closed record
Fields
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mPRODEX: RELATED_LOCATION_TWO_IDENTIFICATION_GType
Closed record
Fields
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.retail.mPRODEX: Sender_GType
Closed record
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.retail.mPRODEX: 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.mPRODEX: SUB_LINE_INFORMATION_GType
Closed record
Fields
- Sub_line_indicator_code? string -
- Line_item_identifier? string -
edifact.d03a.retail.mPRODEX: Syntax_identifier_GType
Closed record
Fields
- syntax_id string -
- syntax_version string -
- service_code_list_directory_version? string -
- character_encoding? string -
edifact.d03a.retail.mPRODEX: TRANSPORT_IDENTIFICATION_GType
Closed record
Fields
- Transport_means_identification_name_identifier? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Transport_means_identification_name? string -
- Transport_means_nationality_code? string -
edifact.d03a.retail.mPRODEX: Transport_information_Type
Closed record
Fields
- code string(default "TDT") -
- TRANSPORT_STAGE_CODE_QUALIFIER? string -
- MEANS_OF_TRANSPORT_JOURNEY_IDENTIFIER? string -
- MODE_OF_TRANSPORT? MODE_OF_TRANSPORT_GType? -
- TRANSPORT_MEANS? TRANSPORT_MEANS_GType? -
- CARRIER? CARRIER_GType? -
- TRANSIT_DIRECTION_INDICATOR_CODE? string -
- EXCESS_TRANSPORTATION_INFORMATION? EXCESS_TRANSPORTATION_INFORMATION_GType? -
- TRANSPORT_IDENTIFICATION? TRANSPORT_IDENTIFICATION_GType? -
- TRANSPORT_MEANS_OWNERSHIP_INDICATOR_CODE? string -
edifact.d03a.retail.mPRODEX: TRANSPORT_MEANS_GType
Closed record
Fields
- Transport_means_description_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Transport_means_description? string -
edifact.d03a.retail.mPRODEX: VALUE_RANGE_GType
Closed record
Fields
- Measurement_unit_code string -
- Measure? string -
- Range_minimum_quantity? int? -
- Range_maximum_quantity? int? -
- Significant_digits_quantity? int? -