Documentation de l'api uploadApi (1.0.0)

Download OpenAPI specification:Download

Documentation et contrat d'interface pour l'api upload, l'api responsable de géstion de fichier.

upload

uploadFlie

Chargement de fichier.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: multipart/form-data
id
string

id technique et unique généré automatiquement et qui identifie un object de chargement de fichier.

fileLink
string

Lien http du fichier dans le serveur FTP.

resources
required
string
Enum: "PERSON" "PARTNER" "HOTE" "TRIPE"

Resource metier concernée par l'upload file.

type
required
string
Enum: "PHOTO" "ID" "SUPPORTING_DOCUMENT"

Type du fichier.

file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "fileLink": "string",
  • "resources": "PERSON",
  • "type": "PHOTO",
  • "file": "string",
  • "links": [
    ]
}

putUpload

modification d'une piece.

path Parameters
upload-id
required
string

id technique du personne.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: multipart/form-data
id
string

id technique et unique généré automatiquement et qui identifie un object de chargement de fichier.

fileLink
string

Lien http du fichier dans le serveur FTP.

resources
required
string
Enum: "PERSON" "PARTNER" "HOTE" "TRIPE"

Resource metier concernée par l'upload file.

type
required
string
Enum: "PHOTO" "ID" "SUPPORTING_DOCUMENT"

Type du fichier.

file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "fileLink": "string",
  • "resources": "PERSON",
  • "type": "PHOTO",
  • "file": "string",
  • "links": [
    ]
}

deleteUpload

suppression d'une piece.

path Parameters
upload-id
required
string

id technique du fichier.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }