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.logistics.mCASRES
ballerinax/edifact.d03a.logistics.mCASRES Ballerina library
1.0.0
Functions
fromEdiString
Isolated Function
function fromEdiString(string ediText) returns EDI_CASRES_CASRES|errorConvert EDI string to Ballerina EDI_CASRES_CASRES record.
Parameters
- ediText string - EDI string to be converted
Return Type
- EDI_CASRES_CASRES|error - Ballerina record or error
fromEdiStringWithSchema
Isolated Function
function fromEdiStringWithSchema(string ediText, EdiSchema schema) returns EDI_CASRES_CASRES|errorConvert EDI string to Ballerina EDI_CASRES_CASRES record with schema.
Return Type
- EDI_CASRES_CASRES|error - Ballerina record or error
getSchema
Isolated Function
Get the EDI schema.
headersFromEdiString
Isolated Function
function headersFromEdiString(string ediText) returns EDI_CASRES_CASRESHeaders|errorParse only the envelope header segments from the given EDI string.
Parameters
- ediText string - EDI string to parse
Return Type
- EDI_CASRES_CASRESHeaders|error - Parsed EDI_CASRES_CASRESHeaders record, or error if the headers are malformed
interchangeFromEdiString
Isolated Function
function interchangeFromEdiString(string ediText) returns EDI_CASRES_CASRESInterchange|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_CASRES_CASRESInterchange|error - Parsed EDI_CASRES_CASRESInterchange, or error if the envelope is malformed
interchangeToEdiString
Isolated Function
function interchangeToEdiString(EDI_CASRES_CASRESInterchange msg) returns string|errorSerialise a EDI_CASRES_CASRESInterchange 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_CASRES_CASRESInterchange - The interchange to serialise
toEdiString
Isolated Function
function toEdiString(EDI_CASRES_CASRES data) returns string|errorConvert Ballerina EDI_CASRES_CASRES record to EDI string.
Parameters
- data EDI_CASRES_CASRES - Ballerina record to be converted
toEdiStringWithSchema
Isolated Function
function toEdiStringWithSchema(EDI_CASRES_CASRES data, EdiSchema ediSchema) returns string|errorConvert Ballerina EDI_CASRES_CASRES record to EDI string with schema.
transformFromEdiString
Isolated Function
Convert EDI string to Ballerina EDI_CASRES_CASRES 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_CASRES_CASRES. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- anydata|error - EDI_CASRES_CASRESHeaders record boxed as anydata, or error
transformInterchangeFromEdiString
Isolated Function
Convert EDI string to a EDI_CASRES_CASRESInterchange record. Narrow the result with ensureType.
Parameters
- ediText string - EDI string to be converted
Return Type
- any|error - EDI_CASRES_CASRESInterchange record boxed as any, or error
transformInterchangeToEdiString
Isolated Function
Convert a EDI_CASRES_CASRESInterchange record to EDI string.
Parameters
- content any - EDI_CASRES_CASRESInterchange record boxed as any
transformToEdiString
Isolated Function
Convert Ballerina EDI_CASRES_CASRES record to EDI string.
Parameters
- content anydata - Ballerina record to be converted
Records
edifact.d03a.logistics.mCASRES: APPLICATION_ERROR_DETAIL_GType
Closed record
Fields
- Application_error_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.logistics.mCASRES: Application_error_information_Type
Closed record
Fields
- code string(default "ERC") -
- APPLICATION_ERROR_DETAIL? APPLICATION_ERROR_DETAIL_GType? -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: 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.logistics.mCASRES: Date_and_time_GType
Closed record
Fields
- date string -
- time string -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: Date_time_period_Type
Closed record
Fields
- code string(default "DTM") -
- DATE_TIME_PERIOD? DATE_TIME_PERIOD_GType? -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: 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.logistics.mCASRES: DOCUMENT_MESSAGE_IDENTIFICATION_GType
Closed record
Fields
- Document_identifier? string -
- Version_identifier? string -
- Revision_identifier? string -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: EDI_CASRES_CASRES
Closed record
Fields
- Beginning_of_message Beginning_of_message_Type -
- Date_time_period Date_time_period_Type[](default []) -
- Application_error_information Application_error_information_Type[](default []) -
- Place_location_identification Place_location_identification_Type[](default []) -
- Reference Reference_Type[](default []) -
- Monetary_amount Monetary_amount_Type[](default []) -
- Free_text Free_text_Type[](default []) -
- group_1 Group_1_GType[](default []) -
- group_2 Group_2_GType[](default []) -
edifact.d03a.logistics.mCASRES: EDI_CASRES_CASRESHeaders
Closed record
Envelope headers of a EDI_CASRES_CASRES interchange.
Fields
- interchange EDI_CASRES_CASRESInterchangeHeader - Interchange header
- 'transaction EDI_CASRES_CASRESTransactionHeader - Transaction header
edifact.d03a.logistics.mCASRES: EDI_CASRES_CASRESInterchange
Closed record
A parsed EDI_CASRES_CASRES interchange with its full envelope hierarchy.
Fields
- interchangeHeader EDI_CASRES_CASRESInterchangeHeader - Interchange header segment
- transactions EDI_CASRES_CASRESTransaction[] - Transactions in the interchange
- interchangeTrailer EDI_CASRES_CASRESInterchangeTrailer - Interchange trailer segment
edifact.d03a.logistics.mCASRES: EDI_CASRES_CASRESInterchangeHeader
Closed record
Fields
- interchange_header Interchange_header_Type -
edifact.d03a.logistics.mCASRES: EDI_CASRES_CASRESInterchangeTrailer
Closed record
Fields
- interchange_trailer Interchange_trailer_Type -
edifact.d03a.logistics.mCASRES: EDI_CASRES_CASRESTransaction
Closed record
A single transaction within a EDI_CASRES_CASRES interchange.
Fields
- transactionHeader EDI_CASRES_CASRESTransactionHeader - Transaction header segment
- body EDI_CASRES_CASRES|error - Parsed EDI_CASRES_CASRES body, or the parse error when the body is malformed
- transactionTrailer EDI_CASRES_CASRESTransactionTrailer - Transaction trailer segment
edifact.d03a.logistics.mCASRES: EDI_CASRES_CASRESTransactionHeader
Closed record
Fields
- Message_header Message_header_Type -
edifact.d03a.logistics.mCASRES: EDI_CASRES_CASRESTransactionTrailer
Closed record
Fields
- Message_trailer Message_trailer_Type -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: Group_1_GType
Closed record
Fields
- Name_and_address Name_and_address_Type -
- Sequence_details? Sequence_details_Type? -
- Free_text Free_text_Type[](default []) -
edifact.d03a.logistics.mCASRES: Group_2_GType
Closed record
Fields
- Document_message_details Document_message_details_Type -
- Related_identification_numbers Related_identification_numbers_Type[](default []) -
- Payment_terms? Payment_terms_Type? -
- Date_time_period Date_time_period_Type[](default []) -
- Monetary_amount Monetary_amount_Type[](default []) -
- Free_text Free_text_Type[](default []) -
edifact.d03a.logistics.mCASRES: IDENTIFICATION_NUMBER_2_GType
Closed record
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mCASRES: IDENTIFICATION_NUMBER_3_GType
Closed record
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mCASRES: IDENTIFICATION_NUMBER_4_GType
Closed record
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mCASRES: IDENTIFICATION_NUMBER_5_GType
Closed record
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mCASRES: IDENTIFICATION_NUMBER_GType
Closed record
Fields
- Object_identifier string -
- Object_identification_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: Interchange_trailer_Type
Closed record
Fields
- code string(default "UNZ") -
- interchange_control_count int -
- interchange_control_reference string -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: Message_header_Type
Closed record
Fields
- code string(default "UNH") -
- message_reference_number string -
- message_identifier Message_identifier_GType -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: Message_trailer_Type
Closed record
Fields
- code string(default "UNT") -
- number_of_segments int -
- message_reference_number string -
edifact.d03a.logistics.mCASRES: MONETARY_AMOUNT_GType
Closed record
Fields
- Monetary_amount_type_code_qualifier string -
- Monetary_amount? int? -
- Currency_identification_code? string -
- Currency_type_code_qualifier? string -
- Status_description_code? string -
edifact.d03a.logistics.mCASRES: Monetary_amount_Type
Closed record
Fields
- code string(default "MOA") -
- MONETARY_AMOUNT? MONETARY_AMOUNT_GType? -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: 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.logistics.mCASRES: PARTY_IDENTIFICATION_DETAILS_GType
Closed record
Fields
- Party_identifier string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: PAYMENT_TERMS_GType
Closed record
Fields
- Payment_terms_description_identifier? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
- Payment_terms_description? string -
edifact.d03a.logistics.mCASRES: Payment_terms_Type
Closed record
Fields
- code string(default "PYT") -
- PAYMENT_TERMS_TYPE_CODE_QUALIFIER? string -
- PAYMENT_TERMS? PAYMENT_TERMS_GType? -
- TIME_REFERENCE_CODE? string -
- TERMS_TIME_RELATION_CODE? string -
- PERIOD_TYPE_CODE? string -
- PERIOD_COUNT_QUANTITY? int? -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: Recipient_GType
Closed record
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.logistics.mCASRES: Recipient_reference_password_GType
Closed record
Fields
- reference_password? string -
- qualifier? string -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: Reference_Type
Closed record
Fields
- code string(default "RFF") -
- REFERENCE? REFERENCE_GType? -
edifact.d03a.logistics.mCASRES: Related_identification_numbers_Type
Closed record
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.mCASRES: RELATED_LOCATION_ONE_IDENTIFICATION_GType
Closed record
Fields
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.logistics.mCASRES: RELATED_LOCATION_TWO_IDENTIFICATION_GType
Closed record
Fields
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.logistics.mCASRES: Sender_GType
Closed record
Fields
- id string -
- qualifier? string -
- internal_id? string -
- internal_sub_id? string -
edifact.d03a.logistics.mCASRES: Sequence_details_Type
Closed record
Fields
- code string(default "SEQ") -
- SEQUENCE_INFORMATION? SEQUENCE_INFORMATION_GType? -
edifact.d03a.logistics.mCASRES: SEQUENCE_INFORMATION_GType
Closed record
Fields
- Sequence_position_identifier string -
- Sequence_identifier_source_code? string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: Syntax_identifier_GType
Closed record
Fields
- syntax_id string -
- syntax_version string -
- service_code_list_directory_version? string -
- character_encoding? string -
edifact.d03a.logistics.mCASRES: 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.logistics.mCASRES: TEXT_REFERENCE_GType
Closed record
Fields
- Free_text_description_code string -
- Code_list_identification_code? string -
- Code_list_responsible_agency_code? string -