File

File DTOs are used to attach documents to our main business objects or to receive documents attached by carriers.

If you want to attach a file to a transport, transport_number field is mandatory.
If you want to attach a file to a delivery, delivery_number is mandatory.

Attribute

Description

Type (Length)

Example

Mandatory

Attribute

Description

Type (Length)

Example

Mandatory

content

Base64 encoded binary data

STRING

SGVsbG8gd29ybGQ=

True

content_encoding

Encoding format

This field is optional, you only need to fill it in if agreed with the project manager

CHAR(20)

UTF-8

False

content_type

Type of the content

This field is optional, you only need to fill it in if agreed with the project manager.
Providing the mandatory field qualifier is usually sufficient.

CHAR(50)

text/plain

False

delivery_number

Delivery number to which the file is added

CHAR(50)

DN123

See description

description

Description of the file

CHAR(200)

CMR

False

name

Name of the file

CHAR(50)

cmr.txt

True

parameters

See Parameter

False

qualifier

Type of the attachment.

See Attachment Qualifiers

Please use the following type if none of the above categories apply:

attachment.type.other

CHAR(50)

attachment.type.other

True

transport_number

Transport number to which the file is added

CHAR(50)

ABC-123

See description