Swagger Enveloppes - OpenAPI 3.0.3
Description des interfaces REST de la ressource enveloppe
Version: 0.0.1
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
post /v2/enveloppes/{numeroDossier}/declarations
Ajouter des déclarations à une enveloppe (ELO) (ajouterDeclarations)
L'utilisateur doit être identifié via RIGHT
Path parameters
numeroDossier (required)
Path Parameter — Numéro de Dossier de l'enveloppe
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Liste d'identifiant de déclaration
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
201
Ajout de déclarations réussi
Enveloppe
400
Erreur Fonctionnelle
ReponseErreur
401
Erreur d'authentification
ReponseErreur
404
Enveloppe non trouvée
ReponseErreur
500
Erreur Technique
ReponseErreur
Créer une enveloppe (ELO) (creerEnveloppe)
L'utilisateur doit être identifié via RIGHT
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Données d'appairage et liste de numéro de déclaration
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
201
Création de l'enveloppe réussie
Enveloppe
400
Erreur Fonctionnelle
ReponseErreur
401
Erreur d'authentification
ReponseErreur
500
Erreur Technique
ReponseErreur
Up
get /v2/enveloppes/{numeroDossier}/pdf
Générer et récupérer le pdf d'une enveloppe (ELO) (genererPdfEnveloppe)
L'utilisateur doit être identifié via RIGHT
Path parameters
numeroDossier (required)
Path Parameter — Numéro de Dossier de l'enveloppe
Return type
String
Example data
Content-Type: application/json
""
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écupération du pdf de l'enveloppe réussie
String
400
Erreur Fonctionnelle
ReponseErreur
401
Erreur d'authentification
ReponseErreur
404
Enveloppe non trouvée
ReponseErreur
500
Erreur Technique
ReponseErreur
Up
patch /v2/enveloppes/{numeroDossier}
Modifier une enveloppe (ELO) (modifierEnveloppe)
L'utilisateur doit être identifié via RIGHT
Path parameters
numeroDossier (required)
Path Parameter — Numéro de Dossier de l'enveloppe
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Données d'appairage
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
Modification de l'enveloppe réussie / Validation de l'enveloppe demandée / Modification de l'enveloppe autorisée
Enveloppe
400
Erreur Fonctionnelle
ReponseErreur
401
Erreur d'authentification
ReponseErreur
404
Enveloppe non trouvée
ReponseErreur
500
Erreur Technique
ReponseErreur
Up
post /v2/enveloppes/{numeroDossier}/statut
Modifier le statut d'un enveloppe (ELO) (modifierStatutEnveloppe)
L'utilisateur doit être identifié via RIGHT
Path parameters
numeroDossier (required)
Path Parameter — Numéro de Dossier de l'enveloppe
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Changement de statut demandé
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
Changement l'enveloppe pris en compte
Enveloppe
400
Erreur Fonctionnelle
ReponseErreur
401
Erreur d'authentification
ReponseErreur
404
Enveloppe non trouvée
ReponseErreur
500
Erreur Technique
ReponseErreur
Up
get /v2/enveloppes/{numeroDossier}/declarations
Rechercher les déclaration d'une enveloppe (ELO) (rechercherDéclarations)
L'utilisateur doit être identifié via RIGHT
Path parameters
numeroDossier (required)
Path Parameter — Numéro de Dossier de l'enveloppe
Query parameters
typesDeclaration (optional)
Query Parameter — Critère de recherche sur les déclaration: le type de déclaration. Si présent correspond implicitement à un type de déclaration sans sous type.
sousTypesDeclaration (optional)
Query Parameter — Critère de recherche sur les déclaration: le sous type de déclaration. Ne pas préciser le type déclaration correspondant qui est implicite.
identifiantDeclaration (optional)
Query Parameter — Identifiant de la déclaration recherchée
numeroPage (optional)
Query Parameter — Numéro de la page à récupérer default: 1
taillePage (optional)
Query Parameter — Taille de la page à récupérer default: 5
ordre (optional)
Query Parameter — Choix de l'ordre du tri : date création croissant ou décroissaant
Return type
Example data
Content-Type: application/json
{
"totalPages" : 0,
"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"
} ],
"totalElements" : 6
}
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
Recherche des déclarations réussie - Résultats complets (ou aucun résultat)
ReponseRechercherDeclarations
206
Recherche des déclarations réussie - Résultats partiels
ReponseRechercherDeclarations
400
Erreur Fonctionnelle
ReponseErreur
401
Erreur d'authentification
ReponseErreur
404
Enveloppe non trouvée
ReponseErreur
500
Erreur Technique
ReponseErreur
Rechercher des enveloppes (ELO) (rechercherEnveloppes)
L'utilisateur doit être identifié via RIGHT
Query parameters
sensTraversee (optional)
Query Parameter — Critère de recherche sur les informations d'appairage: le sens de la traversé
typeCamion (optional)
Query Parameter — Critère de recherche sur les informations d'appairage: le type de camion
statutsEnveloppe (optional)
Query Parameter — Critère de recherche sur les informations de l'enveloppe: statut de l'enveloppe
periode (optional)
Query Parameter — Période de recherche: aucune, mois en cours, 1 mois au choix dans les 5 derniers
tri (optional)
Query Parameter — Choix du tri de l'enveloppe
ordre (optional)
Query Parameter — Choix de l'ordre de tri des enveloppes
numeroPage (optional)
Query Parameter — Numéro de la page à récupérer default: 1
taillePage (optional)
Query Parameter — Taille de la page à récupérer default: 5
Return type
Example data
Content-Type: application/json
{
"enveloppes" : [ {
"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"
}, {
"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"
} ],
"totalPages" : 6,
"totalElements" : 1
}
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
Recherche des enveloppes réussie - Résultats complets (ou aucun résultat)
ReponseRechercherEnveloppes
206
Recherche des enveloppes réussie - Résultats partiels
ReponseRechercherEnveloppes
400
Erreur Fonctionnelle
ReponseErreur
401
Erreur d'authentification
ReponseErreur
500
Erreur Technique
ReponseErreur
Up
get /v2/enveloppes/{numeroDossier}
Récupérer une enveloppe (ELO) (recupererEnveloppe)
L'utilisateur doit être identifié via RIGHT
Path parameters
numeroDossier (required)
Path Parameter — Numéro de Dossier de l'enveloppe
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écupération de l'enveloppe réussie
Enveloppe
401
Erreur d'authentification
ReponseErreur
404
Enveloppe non trouvée
ReponseErreur
500
Erreur Technique
ReponseErreur
Up
delete /v2/enveloppes/{numeroDossier}/declarations/{identifiantDeclaration}
Supprimer une déclaration (supprimerDeclaration)
L'utilisateur doit être identifié via RIGHT
Path parameters
numeroDossier (required)
Path Parameter — Numéro de Dossier de l'enveloppe
identifiantDeclaration (required)
Path Parameter — Identification de la déclaration à supprimer
Return type
Example data
Content-Type: application/json
{
"identifiant" : "identifiant",
"sousTypeDeclaration" : "DEPART",
"typeDeclaration" : "IMPORT",
"informationsValidation" : {
"code" : "code",
"message" : "message",
"etat" : "CONFORME"
},
"dateEnregistrement" : "dateEnregistrement"
}
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
Suppression de la déclaration réussie
Declaration
400
Erreur Fonctionnelle
ReponseErreur
401
Erreur d'authentification
ReponseErreur
404
Enveloppe non trouvée / Déclaration non trouvée
ReponseErreur
500
Erreur Technique
ReponseErreur
Up
delete /v2/enveloppes/{numeroDossier}
Supprimer une enveloppe (ELO) (supprimerEnveloppe)
L'utilisateur doit être identifié via RIGHT
Path parameters
numeroDossier (required)
Path Parameter — Numéro de Dossier de l'enveloppe
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
Suppression de l'enveloppe réussie
Enveloppe
400
Erreur Fonctionnelle
ReponseErreur
401
Erreur d'authentification
ReponseErreur
404
Enveloppe non trouvée
ReponseErreur
500
Erreur Technique
ReponseErreur
[ Jump to Methods ]
Table of Contents
Declaration
Enveloppe
EnveloppeFormatPdf
EtatValidation
InformationsAppairage
InformationsValidation
ModeCreation
Ordre
ParametresRequeteRechercherDeclarations
ParametresRequeteRechercherEnveloppes
ReponseErreur
ReponseRechercherDeclarations
ReponseRechercherEnveloppes
RequeteAjouterDeclarations
RequeteCreerEnveloppe
RequeteModifierEnveloppe
RequeteModifierStatutEnveloppe
SensTraversee
SousTypeDeclaration
StatutEnveloppe
TriRechercherDeclarations
TriRechercherEnveloppes
TypeCamion
TypeDeclaration
identifiant (optional)
typeDeclaration (optional)
sousTypeDeclaration (optional)
informationsValidation (optional)
dateEnregistrement (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)
numeroDossier (optional)
jeton (optional)
dateTelechargement (optional)
informationsAppairage (optional)
nombreENS (optional)
nombreDeclarations (optional)
declarationsImportAnticipe (optional)
declarationsTransitAnticipe (optional)
declarationsTransitPassage (optional)
declarationsECS (optional)
imageCodeBarre (optional)
sensTraversee (optional)
typeCamion (optional)
estTIRATA (optional)
estSPS (optional)
estProduitPeche (optional)
etat (optional)
code (optional)
message (optional)
typesDeclaration (optional)
sousTypesDeclaration (optional)
identifiantDeclaration (optional)
tri (optional)
ordre (optional)
numeroPage (optional)
taillePage (optional)
sensTraversee (optional)
typeCamion (optional)
statutsEnveloppe (optional)
periode (optional)
tri (optional)
ordre (optional)
numeroPage (optional)
taillePage (optional)
message (optional)
code (optional)
declarations (optional)
totalPages (optional)
totalElements (optional)
enveloppes (optional)
totalPages (optional)
totalElements (optional)
identifiantsDeclaration (optional)
informationsAppairage (optional)
identifiantsDeclaration (optional)
informationsAppairage (optional)
changementStatut (optional)
OUVRIR
FERMER
ANNULER_MODIFICATIONS