Swagger JMS Opérateur - OpenAPI 3.0.3

Déscription des échanges entre InterBrexit et les Opérateurs à travers l’application GUN2. v1.0
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
post /enveloppe
CreerEnveloppe (creerENV)
Création d'une enveloppe au status "fermée"

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RequeteCreerEnveloppe (optional)
Body Parameter — Échange entrant au format JSON

Request headers

Return type

ENV_CRE02

Example data

Content-Type: application/json
{
  "numeroDossier" : "numeroDossier",
  "dateCreation" : "dateCreation",
  "dateModification" : "dateModification",
  "aUneELOValide" : true,
  "dateEmbarquement" : "dateEmbarquement",
  "estUnBrouillon" : true,
  "declarations" : [ {
    "identifiant" : "identifiant",
    "sousTypeDeclaration" : "DEPART",
    "typeDeclaration" : "IMPORT",
    "informationsValidation" : {
      "code" : "code",
      "message" : "message",
      "etat" : "CONFORME"
    },
    "dateEnregistrement" : "dateEnregistrement"
  }, {
    "identifiant" : "identifiant",
    "sousTypeDeclaration" : "DEPART",
    "typeDeclaration" : "IMPORT",
    "informationsValidation" : {
      "code" : "code",
      "message" : "message",
      "etat" : "CONFORME"
    },
    "dateEnregistrement" : "dateEnregistrement"
  } ],
  "dateDebarquement" : "dateDebarquement",
  "nombreDeclaration" : 0,
  "dateAppairage" : "dateAppairage",
  "modeCreation" : "EDI",
  "informationsAppairage" : {
    "sensTraversee" : "ENTREE",
    "typeCamion" : "VIDE",
    "estSPS" : true,
    "estProduitPeche" : true,
    "estTIRATA" : true
  },
  "jeton" : "jeton",
  "dateValidation" : "dateValidation",
  "statut" : "APPAIREE"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Réponse OK ENV_CRE02

400

Réponse KO ENV_CRE03

Up
post /enveloppe/modifier
ModifierEnveloppe (modifierENV)
Modification d'une enveloppe au status "fermée"

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ENV_MOD01 (optional)
Body Parameter — Échange entrant au format JSON

Request headers

Return type

ENV_MOD02

Example data

Content-Type: application/json
{
  "numeroDossier" : "numeroDossier",
  "dateCreation" : "dateCreation",
  "dateModification" : "dateModification",
  "aUneELOValide" : true,
  "dateEmbarquement" : "dateEmbarquement",
  "estUnBrouillon" : true,
  "declarations" : [ {
    "identifiant" : "identifiant",
    "sousTypeDeclaration" : "DEPART",
    "typeDeclaration" : "IMPORT",
    "informationsValidation" : {
      "code" : "code",
      "message" : "message",
      "etat" : "CONFORME"
    },
    "dateEnregistrement" : "dateEnregistrement"
  }, {
    "identifiant" : "identifiant",
    "sousTypeDeclaration" : "DEPART",
    "typeDeclaration" : "IMPORT",
    "informationsValidation" : {
      "code" : "code",
      "message" : "message",
      "etat" : "CONFORME"
    },
    "dateEnregistrement" : "dateEnregistrement"
  } ],
  "dateDebarquement" : "dateDebarquement",
  "nombreDeclaration" : 0,
  "dateAppairage" : "dateAppairage",
  "modeCreation" : "EDI",
  "informationsAppairage" : {
    "sensTraversee" : "ENTREE",
    "typeCamion" : "VIDE",
    "estSPS" : true,
    "estProduitPeche" : true,
    "estTIRATA" : true
  },
  "jeton" : "jeton",
  "dateValidation" : "dateValidation",
  "statut" : "APPAIREE"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Réponse OK ENV_MOD02

400

Réponse KO ENV_MOD03

Up
post /enveloppe/recuperer
RecupererEnveloppe (recupererENV)
Récupération d'une enveloppe

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body ENV_REC01 (optional)
Body Parameter — Échange entrant au format JSON

Request headers

Return type

ENV_REC02

Example data

Content-Type: application/json
{
  "numeroDossier" : "numeroDossier",
  "dateCreation" : "dateCreation",
  "dateModification" : "dateModification",
  "aUneELOValide" : true,
  "dateEmbarquement" : "dateEmbarquement",
  "estUnBrouillon" : true,
  "declarations" : [ {
    "identifiant" : "identifiant",
    "sousTypeDeclaration" : "DEPART",
    "typeDeclaration" : "IMPORT",
    "informationsValidation" : {
      "code" : "code",
      "message" : "message",
      "etat" : "CONFORME"
    },
    "dateEnregistrement" : "dateEnregistrement"
  }, {
    "identifiant" : "identifiant",
    "sousTypeDeclaration" : "DEPART",
    "typeDeclaration" : "IMPORT",
    "informationsValidation" : {
      "code" : "code",
      "message" : "message",
      "etat" : "CONFORME"
    },
    "dateEnregistrement" : "dateEnregistrement"
  } ],
  "dateDebarquement" : "dateDebarquement",
  "nombreDeclaration" : 0,
  "dateAppairage" : "dateAppairage",
  "modeCreation" : "EDI",
  "informationsAppairage" : {
    "sensTraversee" : "ENTREE",
    "typeCamion" : "VIDE",
    "estSPS" : true,
    "estProduitPeche" : true,
    "estTIRATA" : true
  },
  "jeton" : "jeton",
  "dateValidation" : "dateValidation",
  "statut" : "APPAIREE"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Réponse OK ENV_REC02

400

Réponse KO ENV_REC03

Models

[ Jump to Methods ]

Table of Contents

  1. Declaration
  2. ENV_CRE01
  3. ENV_CRE02
  4. ENV_CRE03
  5. ENV_MOD01
  6. ENV_MOD02
  7. ENV_MOD03
  8. ENV_NOT01
  9. ENV_REC01
  10. ENV_REC02
  11. ENV_REC03
  12. Enveloppe
  13. EtatValidation
  14. EvenementUniteTransport
  15. InformationsAppairage
  16. InformationsValidation
  17. ModeCreation
  18. ReponseMessageEnveloppeErreur
  19. RequeteCreerEnveloppe
  20. SensTraversee
  21. SousTypeDeclaration
  22. StatutEnveloppe
  23. TypeCamion
  24. TypeDeclaration

Declaration Up

identifiant (optional)
typeDeclaration (optional)
sousTypeDeclaration (optional)
informationsValidation (optional)
dateEnregistrement (optional)

ENV_CRE01 Up

ENV_CRE02 Up

ENV_CRE03 Up

informationsErreur (optional)
enveloppe (optional)

ENV_MOD01 Up

numeroDossier (optional)
informationsAppairage (optional)
identifiantsDeclarationAAjouter (optional)
identifiantsDeclarationASupprimer (optional)

ENV_MOD02 Up

ENV_MOD03 Up

informationsErreur (optional)
enveloppe (optional)

ENV_NOT01 Up

evenement (optional)
enveloppe (optional)

ENV_REC01 Up

numeroDossier (optional)

ENV_REC02 Up

ENV_REC03 Up

informationsErreur (optional)
numeroDossier (optional)

Enveloppe Up

jeton (optional)
numeroDossier (optional)
statut (optional)
modeCreation (optional)
informationsAppairage (optional)
declarations (optional)
nombreDeclaration (optional)
dateCreation (optional)
dateModification (optional)
dateValidation (optional)
dateAppairage (optional)
dateEmbarquement (optional)
dateDebarquement (optional)
estUnBrouillon (optional)
aUneELOValide (optional)

EtatValidation Up

EvenementUniteTransport Up

InformationsAppairage Up

sensTraversee (optional)
typeCamion (optional)
estTIRATA (optional)
estSPS (optional)
estProduitPeche (optional)

InformationsValidation Up

etat (optional)
code (optional)
message (optional)

ModeCreation Up

ReponseMessageEnveloppeErreur Up

numeroDossier (optional)
statut (optional)
example: FONC-ERR-001
libelleErreur (optional)

RequeteCreerEnveloppe Up

informationsAppairage (optional)
identifiantsDeclaration (optional)

SensTraversee Up

SousTypeDeclaration Up

StatutEnveloppe Up

TypeCamion Up

TypeDeclaration Up