Resources and objects

The structure of the objects (and their fields) used when calling a Messaging REST API operation and the responses of the operations are documented in SwaggerUI as Request body Schema and Response Schema respectively.

Following is a brief description of the most common objects.

sedex ID

Each participant using the sedex platform is issued a unique sedex ID by sedex Customer Support.

Unique sedex Message ID

Each registered sedex message is assigned a Unique sedex Message ID (USMID). It is used when uploading a payload, checking the status of a sent message, etc.

sedex Message

A sedex message is used to exchange messages between the participants of the sedex platform. A sedex message always consists of two components:

1. A sedex envelope
2. sedex payload file

sedex Envelope

The sedex envelope contains the metadata of a message.

sedex Payload

The payload file contains the business data to be transmitted. sedex can transfer payload files of any type, the most common being XML, JSON, and ZIP. ZIP files can be used to transfer several related files as one sedex message.

sedex Receipt

The sedex platform provides a receipt for each recipient of a sedex message. The receipt informs the sending business application about the final status of a sedex message: Was it successfully delivered to the recipient or did an error prevent delivery to the recipient?