Swagger JMS Opérateur - OpenAPI 3.0.3
Déscription des échanges entre InterBrexit et les Opérateurs à travers l’application GUN2. v1.0
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
CreerEnveloppe (creerENV)
Création d'une enveloppe au status "fermée"
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Échange entrant au format JSON
Request headers
Return type
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 request header;
the media type will be conveyed by the 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 request header:
Request body
Body Parameter — Échange entrant au format JSON
Request headers
Return type
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 request header;
the media type will be conveyed by the 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 request header:
Request body
Body Parameter — Échange entrant au format JSON
Request headers
Return type
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 request header;
the media type will be conveyed by the response header.
Responses
200
Réponse OK
ENV_REC02
400
Réponse KO
ENV_REC03
[ Jump to Methods ]
Table of Contents
Declaration
ENV_CRE01
ENV_CRE02
ENV_CRE03
ENV_MOD01
ENV_MOD02
ENV_MOD03
ENV_NOT01
ENV_REC01
ENV_REC02
ENV_REC03
Enveloppe
EtatValidation
EvenementUniteTransport
InformationsAppairage
InformationsValidation
ModeCreation
ReponseMessageEnveloppeErreur
RequeteCreerEnveloppe
SensTraversee
SousTypeDeclaration
StatutEnveloppe
TypeCamion
TypeDeclaration
identifiant (optional)
typeDeclaration (optional)
sousTypeDeclaration (optional)
informationsValidation (optional)
dateEnregistrement (optional)
informationsErreur (optional)
enveloppe (optional)
numeroDossier (optional)
informationsAppairage (optional)
identifiantsDeclarationAAjouter (optional)
identifiantsDeclarationASupprimer (optional)
informationsErreur (optional)
enveloppe (optional)
evenement (optional)
enveloppe (optional)
informationsErreur (optional)
numeroDossier (optional)
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)
sensTraversee (optional)
typeCamion (optional)
estTIRATA (optional)
estSPS (optional)
estProduitPeche (optional)
etat (optional)
code (optional)
message (optional)
numeroDossier (optional)
statut (optional)
example: FONC-ERR-001
libelleErreur (optional)
informationsAppairage (optional)
identifiantsDeclaration (optional)