edifact.d03a.logistics.mSSIMOD
Modules
edifact.d03a.logistics.mSSIMOD
edifact.d03a.logistics.mSSRECHedifact.d03a.logistics.mSSREGWedifact.d03a.logistics.mTANSTAedifact.d03a.logistics.mTPFREPModule edifact.d03a.logistics.mSSIMOD
API
Definitions
ballerinax/edifact.d03a.logistics.mSSIMOD Ballerina library
Functions
fromEdiString
function fromEdiString(string ediText) returns EDI_SSIMOD_SSIMOD|errorConvert EDI string to Ballerina EDI_SSIMOD_SSIMOD record.
Parameters
- ediText string - EDI string to be converted
Return Type
- EDI_SSIMOD_SSIMOD|error - Ballerina record or error
fromEdiStringWithSchema
function fromEdiStringWithSchema(string ediText, EdiSchema schema) returns EDI_SSIMOD_SSIMOD|errorConvert EDI string to Ballerina EDI_SSIMOD_SSIMOD record with schema.
Return Type
- EDI_SSIMOD_SSIMOD|error - Ballerina record or error
getSchema
Get the EDI schema.
headersFromEdiString
function headersFromEdiString(string ediText) returns EDI_SSIMOD_SSIMODHeaders|errorParse only the envelope header segments from the given EDI string.
Parameters
- ediText string - EDI string to parse
Return Type
- EDI_SSIMOD_SSIMODHeaders|error - Parsed EDI_SSIMOD_SSIMODHeaders record, or error if the headers are malformed
interchangeFromEdiString
function interchangeFromEdiString(string ediText) returns EDI_SSIMOD_SSIMODInterchange|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_SSIMOD_SSIMODInterchange|error - Parsed EDI_SSIMOD_SSIMODInterchange, or error if the envelope is malformed
interchangeToEdiString
function interchangeToEdiString(EDI_SSIMOD_SSIMODInterchange msg) returns string|errorSerialise a EDI_SSIMOD_SSIMODInterchange 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_SSIMOD_SSIMODInterchange - The interchange to serialise
toEdiString
function toEdiString(EDI_SSIMOD_SSIMOD data) returns string|errorConvert Ballerina EDI_SSIMOD_SSIMOD record to EDI string.
Parameters
- data EDI_SSIMOD_SSIMOD - Ballerina record to be converted
toEdiStringWithSchema
function toEdiStringWithSchema(EDI_SSIMOD_SSIMOD data, EdiSchema ediSchema) returns string|errorConvert Ballerina EDI_SSIMOD_SSIMOD record to EDI string with schema.
transformFromEdiString
Convert EDI string to Ballerina EDI_SSIMOD_SSIMOD record.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - Ballerina record or error
transformHeadersFromEdiString
Convert EDI string to the envelope headers of EDI_SSIMOD_SSIMOD. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - EDI_SSIMOD_SSIMODHeaders record boxed as anydata, or error
transformInterchangeFromEdiString
Convert EDI string to a EDI_SSIMOD_SSIMODInterchange record. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- any|error - EDI_SSIMOD_SSIMODInterchange record boxed as any, or error
transformInterchangeToEdiString
Convert a EDI_SSIMOD_SSIMODInterchange record to EDI string.
Parameters
- content any - EDI_SSIMOD_SSIMODInterchange record boxed as any
transformToEdiString
Convert Ballerina EDI_SSIMOD_SSIMOD record to EDI string.
Parameters
- content anydata - Ballerina record to be converted
Records
edifact.d03a.logistics.mSSIMOD: ADDRESS_DETAILS_GType
Fields
- Address_format_code string -
- Address_component_description string -
- Address_component_description_2? string -
- Address_component_description_3? string -
- Address_component_description_4? string -
- Address_component_description_5? string -
edifact.d03a.logistics.mSSIMOD: Address_Type
Fields
- code string(default "ADR") -
- ADDRESS_USAGE? ADDRESS_USAGE_GType? -
- ADDRESS_DETAILS? ADDRESS_DETAILS_GType? -
- CITY_NAME? string -
- POSTAL_IDENTIFICATION_CODE? string -
- COUNTRY_NAME_CODE? string -
- COUNTRY_SUB_ENTITY_DETAILS COUNTRY_SUB_ENTITY_DETAILS_GType[](default []) -
- LOCATION_IDENTIFICATION LOCATION_IDENTIFICATION_GType[](default []) -
edifact.d03a.logistics.mSSIMOD: ADDRESS_USAGE_GType
Fields
- Address_purpose_code? string -
- Address_type_code? string -
- Address_status_code? string -
edifact.d03a.logistics.mSSIMOD: ATTRIBUTE_DETAIL_GType
Fields
- Attribute_description_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Attribute_description? string -
edifact.d03a.logistics.mSSIMOD: Attribute_Type
Fields
- code string(default "ATT") -
- ATTRIBUTE_FUNCTION_CODE_QUALIFIER? string -
- ATTRIBUTE_TYPE? ATTRIBUTE_TYPE_GType? -
- ATTRIBUTE_DETAIL ATTRIBUTE_DETAIL_GType[](default []) -
edifact.d03a.logistics.mSSIMOD: ATTRIBUTE_TYPE_GType
Fields
- Attribute_type_description_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Attribute_type_description? string -
edifact.d03a.logistics.mSSIMOD: Authentication_result_Type
Fields
- code string(default "AUT") -
- VALIDATION_RESULT_TEXT? string -
- VALIDATION_KEY_IDENTIFIER? string -
edifact.d03a.logistics.mSSIMOD: Beginning_of_message_Type
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.logistics.mSSIMOD: COUNTRY_SUB_ENTITY_DETAILS_GType
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.logistics.mSSIMOD: Date_and_time_GType
Fields
- date string -
- time string -
edifact.d03a.logistics.mSSIMOD: DATE_TIME_PERIOD_GType
Fields
- Date_or_time_or_period? string -
- Date_or_time_or_period_text? string -
- Date_or_time_or_period_format_code? string -
edifact.d03a.logistics.mSSIMOD: Date_time_period_Type
Fields
- code string(default "DTM") -
- DATE_TIME_PERIOD? DATE_TIME_PERIOD_GType? -
edifact.d03a.logistics.mSSIMOD: DOCUMENT_MESSAGE_DETAILS_GType
Fields
- Document_identifier? string -
- Document_status_code? string -
- Document_source_description? string -
- Language_name_code? string -
- Version_identifier? string -
- Revision_identifier? string -
edifact.d03a.logistics.mSSIMOD: Document_message_details_Type
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.logistics.mSSIMOD: DOCUMENT_MESSAGE_IDENTIFICATION_GType
Fields
- Document_identifier? string -
- Version_identifier? string -
- Revision_identifier? string -
edifact.d03a.logistics.mSSIMOD: DOCUMENT_MESSAGE_NAME_GType
Fields
- Document_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Document_name? string -
edifact.d03a.logistics.mSSIMOD: EDI_SSIMOD_SSIMOD
Fields
- Beginning_of_message Beginning_of_message_Type -
- Date_time_period? Date_time_period_Type? -
- Processing_information Processing_information_Type -
- group_1? Group_1_GType? -
- group_2 Group_2_GType[](default []) -
- group_6? Group_6_GType? -
edifact.d03a.logistics.mSSIMOD: EDI_SSIMOD_SSIMODHeaders
Envelope headers of a EDI_SSIMOD_SSIMOD interchange.
Fields
- interchange EDI_SSIMOD_SSIMODInterchangeHeader - Interchange header
- 'transaction EDI_SSIMOD_SSIMODTransactionHeader - Transaction header
edifact.d03a.logistics.mSSIMOD: EDI_SSIMOD_SSIMODInterchange
A parsed EDI_SSIMOD_SSIMOD interchange with its full envelope hierarchy.
Fields
- interchangeHeader EDI_SSIMOD_SSIMODInterchangeHeader - Interchange header segment
- transactions EDI_SSIMOD_SSIMODTransaction[] - Transactions in the interchange
- interchangeTrailer EDI_SSIMOD_SSIMODInterchangeTrailer - Interchange trailer segment
edifact.d03a.logistics.mSSIMOD: EDI_SSIMOD_SSIMODInterchangeHeader
Fields
- interchange_header Interchange_header_Type -
edifact.d03a.logistics.mSSIMOD: EDI_SSIMOD_SSIMODInterchangeTrailer
Fields
- interchange_trailer Interchange_trailer_Type -
edifact.d03a.logistics.mSSIMOD: EDI_SSIMOD_SSIMODTransaction
A single transaction within a EDI_SSIMOD_SSIMOD interchange.
Fields
- transactionHeader EDI_SSIMOD_SSIMODTransactionHeader - Transaction header segment
- body EDI_SSIMOD_SSIMOD|error - Parsed EDI_SSIMOD_SSIMOD body, or the parse error when the body is malformed
- transactionTrailer EDI_SSIMOD_SSIMODTransactionTrailer - Transaction trailer segment
edifact.d03a.logistics.mSSIMOD: EDI_SSIMOD_SSIMODTransactionHeader
Fields
- Message_header Message_header_Type -
edifact.d03a.logistics.mSSIMOD: EDI_SSIMOD_SSIMODTransactionTrailer
Fields
- Message_trailer Message_trailer_Type -
edifact.d03a.logistics.mSSIMOD: Free_text_Type
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.logistics.mSSIMOD: Group_1_GType
Fields
- Reference Reference_Type -
- Date_time_period? Date_time_period_Type? -
edifact.d03a.logistics.mSSIMOD: Group_2_GType
Fields
- Index_details Index_details_Type -
- Free_text? Free_text_Type? -
- group_3 Group_3_GType[](default []) -
edifact.d03a.logistics.mSSIMOD: Group_3_GType
Fields
- Party_identification Party_identification_Type -
- Address Address_Type[](default []) -
- Related_identification_numbers? Related_identification_numbers_Type? -
- Nationality? Nationality_Type? -
- Document_message_details? Document_message_details_Type? -
- Attribute Attribute_Type[](default []) -
- group_4 Group_4_GType[](default []) -
- group_5? Group_5_GType? -
edifact.d03a.logistics.mSSIMOD: Group_4_GType
Fields
- Date_time_period Date_time_period_Type -
- Address? Address_Type? -
edifact.d03a.logistics.mSSIMOD: Group_5_GType
Fields
- Person_demographic_information Person_demographic_information_Type -
- Date_time_period Date_time_period_Type[](default []) -
edifact.d03a.logistics.mSSIMOD: Group_6_GType
Fields
- Authentication_result Authentication_result_Type -
- Date_time_period? Date_time_period_Type? -
edifact.d03a.logistics.mSSIMOD: IDENTIFICATION_NUMBER_2_GType
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mSSIMOD: IDENTIFICATION_NUMBER_3_GType
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mSSIMOD: IDENTIFICATION_NUMBER_4_GType
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mSSIMOD: IDENTIFICATION_NUMBER_5_GType
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mSSIMOD: IDENTIFICATION_NUMBER_GType
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mSSIMOD: Index_details_Type
Fields
- code string(default "IND") -
- INDEX_IDENTIFICATION? INDEX_IDENTIFICATION_GType? -
- INDEX_VALUE? INDEX_VALUE_GType? -
edifact.d03a.logistics.mSSIMOD: INDEX_IDENTIFICATION_GType
Fields
- Index_code_qualifier string -
- Index_type_identifier? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.logistics.mSSIMOD: INDEX_VALUE_GType
Fields
- Index_text string -
- Index_representation_code? string -
edifact.d03a.logistics.mSSIMOD: Interchange_header_Type
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.logistics.mSSIMOD: Interchange_trailer_Type
Fields
- code string(default "UNZ") -
- interchange_control_count int -
- interchange_control_reference string -
edifact.d03a.logistics.mSSIMOD: LOCATION_IDENTIFICATION_GType
Fields
- Location_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Location_name? string -
edifact.d03a.logistics.mSSIMOD: MARITAL_STATUS_DETAILS_GType
Fields
- Marital_status_description_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Marital_status_description? string -
edifact.d03a.logistics.mSSIMOD: Message_header_Type
Fields
- code string(default "UNH") -
- message_reference_number string -
- message_identifier Message_identifier_GType -
edifact.d03a.logistics.mSSIMOD: Message_identifier_GType
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.logistics.mSSIMOD: Message_trailer_Type
Fields
- code string(default "UNT") -
- number_of_segments int -
- message_reference_number string -
edifact.d03a.logistics.mSSIMOD: NAME_COMPONENT_DETAILS_6_GType
Fields
- Name_component_type_code_qualifier string -
- Name_component_description? string -
- Name_component_usage_code? string -
- Name_original_alphabet_code? string -
edifact.d03a.logistics.mSSIMOD: NAME_COMPONENT_DETAILS_7_GType
Fields
- Name_component_type_code_qualifier string -
- Name_component_description? string -
- Name_component_usage_code? string -
- Name_original_alphabet_code? string -
edifact.d03a.logistics.mSSIMOD: NAME_COMPONENT_DETAILS_8_GType
Fields
- Name_component_type_code_qualifier string -
- Name_component_description? string -
- Name_component_usage_code? string -
- Name_original_alphabet_code? string -
edifact.d03a.logistics.mSSIMOD: NAME_COMPONENT_DETAILS_9_GType
Fields
- Name_component_type_code_qualifier string -
- Name_component_description? string -
- Name_component_usage_code? string -
- Name_original_alphabet_code? string -
edifact.d03a.logistics.mSSIMOD: NAME_COMPONENT_DETAILS_GType
Fields
- Name_component_type_code_qualifier string -
- Name_component_description? string -
- Name_component_usage_code? string -
- Name_original_alphabet_code? string -
edifact.d03a.logistics.mSSIMOD: NATIONALITY_DETAILS_GType
Fields
- Nationality_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Nationality_name? string -
edifact.d03a.logistics.mSSIMOD: Nationality_Type
Fields
- code string(default "NAT") -
- NATIONALITY_CODE_QUALIFIER? string -
- NATIONALITY_DETAILS? NATIONALITY_DETAILS_GType? -
edifact.d03a.logistics.mSSIMOD: PARTY_IDENTIFICATION_DETAILS_GType
Fields
- Party_identifier string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.logistics.mSSIMOD: Party_identification_Type
Fields
- code string(default "PNA") -
- PARTY_FUNCTION_CODE_QUALIFIER? string -
- IDENTIFICATION_NUMBER? IDENTIFICATION_NUMBER_GType? -
- PARTY_IDENTIFICATION_DETAILS? PARTY_IDENTIFICATION_DETAILS_GType? -
- NAME_TYPE_CODE? string -
- NAME_STATUS_CODE? string -
- NAME_COMPONENT_DETAILS? NAME_COMPONENT_DETAILS_GType? -
- NAME_COMPONENT_DETAILS_6? NAME_COMPONENT_DETAILS_6_GType? -
- NAME_COMPONENT_DETAILS_7? NAME_COMPONENT_DETAILS_7_GType? -
- NAME_COMPONENT_DETAILS_8? NAME_COMPONENT_DETAILS_8_GType? -
- NAME_COMPONENT_DETAILS_9? NAME_COMPONENT_DETAILS_9_GType? -
edifact.d03a.logistics.mSSIMOD: Person_demographic_information_Type
Fields
- code string(default "PDI") -
- GENDER_CODE? string -
- MARITAL_STATUS_DETAILS? MARITAL_STATUS_DETAILS_GType? -
- RELIGION_DETAILS? RELIGION_DETAILS_GType? -
edifact.d03a.logistics.mSSIMOD: PROCESSING_INDICATOR_GType
Fields
- Processing_indicator_description_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Processing_indicator_description? string -
edifact.d03a.logistics.mSSIMOD: Processing_information_Type
Fields
- code string(default "GEI") -
- PROCESSING_INFORMATION_CODE_QUALIFIER? string -
- PROCESSING_INDICATOR? PROCESSING_INDICATOR_GType? -
- PROCESS_TYPE_DESCRIPTION_CODE? string -
edifact.d03a.logistics.mSSIMOD: Recipient_GType
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.logistics.mSSIMOD: Recipient_reference_password_GType
Fields
- reference_password? string -
- qualifier? string -
edifact.d03a.logistics.mSSIMOD: REFERENCE_GType
Fields
- Reference_code_qualifier string -
- Reference_identifier? string -
- Document_line_identifier? string -
- Reference_version_identifier? string -
- Revision_identifier? string -
edifact.d03a.logistics.mSSIMOD: Reference_Type
Fields
- code string(default "RFF") -
- REFERENCE? REFERENCE_GType? -
edifact.d03a.logistics.mSSIMOD: Related_identification_numbers_Type
Fields
- code string(default "GIR") -
- SET_TYPE_CODE_QUALIFIER? string -
- IDENTIFICATION_NUMBER? IDENTIFICATION_NUMBER_GType? -
- IDENTIFICATION_NUMBER_2? IDENTIFICATION_NUMBER_2_GType? -
- IDENTIFICATION_NUMBER_3? IDENTIFICATION_NUMBER_3_GType? -
- IDENTIFICATION_NUMBER_4? IDENTIFICATION_NUMBER_4_GType? -
- IDENTIFICATION_NUMBER_5? IDENTIFICATION_NUMBER_5_GType? -
edifact.d03a.logistics.mSSIMOD: RELIGION_DETAILS_GType
Fields
- Religion_name_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Religion_name? string -
edifact.d03a.logistics.mSSIMOD: Sender_GType
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.logistics.mSSIMOD: Syntax_identifier_GType
Fields
- syntax_id string -
- syntax_version string -
- service_code_list_directory_version? string -
- character_encoding? string -
edifact.d03a.logistics.mSSIMOD: TEXT_LITERAL_GType
Fields
- Free_text string -
- Free_text_1? string -
- Free_text_2? string -
- Free_text_3? string -
- Free_text_4? string -
edifact.d03a.logistics.mSSIMOD: TEXT_REFERENCE_GType
Fields
- Free_text_description_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
Import
import ballerinax/edifact.d03a.logistics.mSSIMOD;Metadata
Released date: 4 days ago
Version: 1.0.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 25
Current verison: 1
Weekly downloads
Keywords
transport
freight
EDI
EDIFACT
D03A
Vendor/Other
Area/ERP & Business Operations
Type/Library
Name/EDIFACT D03A Logistics
Contributors
Dependencies