API docs by Redocly

Documentation de l'api partnersApi (1.0.0)

Download OpenAPI specification:Download

Terms of Service

Documentation et contrat d'interface pour l'api partnersApi, l'api responsable de la gestion d'une personnes morales (gestion d'un partenaire).

Organismes

addOrganization

création d'un Organisme au tant qu'objet métier.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

Identifiant technique et unique généré automatiquement, qui identifie un organisme.

name
required
string

Nom du partenaire.

picture
string

lien vers le logo du partenaire.

required
object (Address)
status
string
Enum: "MISSING_INFORMATIONS" "COMPLETED"

Le statut du partenaire.

  • Par défaut, l'organisme est créé avec le statut : "MISSING_INFORMATIONS".
  • A chaque connexion il faut contrôler si le statut est passé à COMPLETED, afin de notifer le represetant légal qu'il doit remplir les informations de son organisme

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

listOrganizations

Lister des organismes.

query Parameters
currentPage
integer >= 0

le numéro de la page actuelle, si 1er appel ne pas envoyer cet attribut.

sizePage
integer >= 3

Nombre d'éléments par page.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

getOrganization

récupération des informations de l'organisme par son id.

path Parameters
organization-id
required
string

id technique de l'organisme.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

putOrganization

modification d'un organisme.

path Parameters
organization-id
required
string

id technique de l'organisme.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

Identifiant technique et unique généré automatiquement, qui identifie un organisme.

name
required
string

Nom du partenaire.

picture
string

lien vers le logo du partenaire.

required
object (Address)
status
string
Enum: "MISSING_INFORMATIONS" "COMPLETED"

Le statut du partenaire.

  • Par défaut, l'organisme est créé avec le statut : "MISSING_INFORMATIONS".
  • A chaque connexion il faut contrôler si le statut est passé à COMPLETED, afin de notifer le represetant légal qu'il doit remplir les informations de son organisme

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

deleteOrganization

suppression d'un organisme.

path Parameters
organization-id
required
string

id technique d'un organisme.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }

activateOrganization

activation d'un organisme.

path Parameters
organization-id
required
string

id technique de l'organisme.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

deactivateOrganization

désactivation d'un organisme.

path Parameters
organization-id
required
string

id technique de l'organisme.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "picture": "string",
  • "address": {
    },
  • "status": "MISSING_INFORMATIONS"
}

Etablissements

addEstablishment

création d'un établissement au tant qu'objet métier.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

Identifiant technique et unique généré automatiquement, qui identifie un établissement.

parentOrganism
required
string

Identifiant technique de l'organisime parent.

name
required
string

Nom de l'établissement.

legalStatus
string
Enum: "EI" "SA" "SARL" "SAS" "SCS" "SCA" "SEP" "SNC" "GIE"

Forme juridique de l'établissement:

  • Entreprise individuelle (EI)
  • Société Anonyme (SA)
  • Société à Responsabilité Limitée (SARL)
  • Société Anonyme Simplifiée (SAS)
  • Société en Commandite Simple (SCS)
  • Société en Commandite par Actions (SCA)
  • Société en Participation (SEP)
  • Société en nom collectif (SNC)
  • Groupement d'intérêt économique (GIE)
object (Address)
supportingDocumentsID
string

Identifiant technique du document justificatif de l'identité de l'établissement.

status
string
Enum: "MISSING_INFORMATIONS" "ACTIVATED" "DISABLED"

Le statut de l'établissement.

  • Par défaut, l'établissement est créé avec le statut : "MISSING_INFORMATIONS".
  • Pour que l'établissement soit actif et puisse exercer une activité sur notre plateforme, il doit avoir le statut : "ACTIVATED"
  • Pour passer au statut "ACTIVATED", il faut renseigner les informations suivantes :
    • legalStatus
    • address
    • supportingDocumentsID (fournir un document justifiant l'identité de l'entreprise)
    • companyInformation
    • avoir au moins une personne physique avec (statut = "ACTIVATED" et rôle = "ADMIN_PRO")
Array of objects (extensionAttribut)

Informations de l'entreprise (identité).

activities
Array of strings
Items Enum: "TRAVEL_SERVICE" "ACCOMMODATION_SERVICE"

Liste d'activités que l'établissemnt peux exercer :

  • pour les agences de voyages, le type est : TRAVEL_SERVICE
  • pour les établissements d'hébergement (hôtel, auberge, etc.), le type est : ACCOMMODATION_SERVICE

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "companyInformation": [
    ],
  • "activities": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "companyInformation": [
    ],
  • "activities": [
    ]
}

listEstablishments

Lister des éstablishments.

query Parameters
organization-id
string

id technique de l'organisation.

currentPage
integer >= 1

le numéro de la page actuelle, si 1er appel ne pas envoyer cet attribut.

sizePage
integer >= 3

Nombre d'éléments par page.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

getEstablishment

récupération des informations de l'établissement par son id.

path Parameters
establishment-id
required
string

id technique de l'établissement.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "companyInformation": [
    ],
  • "activities": [
    ]
}

putestablishment

modification d'un établissement.

path Parameters
establishment-id
required
string

id technique de l'établissement.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

Identifiant technique et unique généré automatiquement, qui identifie un établissement.

parentOrganism
required
string

Identifiant technique de l'organisime parent.

name
required
string

Nom de l'établissement.

legalStatus
string
Enum: "EI" "SA" "SARL" "SAS" "SCS" "SCA" "SEP" "SNC" "GIE"

Forme juridique de l'établissement:

  • Entreprise individuelle (EI)
  • Société Anonyme (SA)
  • Société à Responsabilité Limitée (SARL)
  • Société Anonyme Simplifiée (SAS)
  • Société en Commandite Simple (SCS)
  • Société en Commandite par Actions (SCA)
  • Société en Participation (SEP)
  • Société en nom collectif (SNC)
  • Groupement d'intérêt économique (GIE)
object (Address)
supportingDocumentsID
string

Identifiant technique du document justificatif de l'identité de l'établissement.

status
string
Enum: "MISSING_INFORMATIONS" "ACTIVATED" "DISABLED"

Le statut de l'établissement.

  • Par défaut, l'établissement est créé avec le statut : "MISSING_INFORMATIONS".
  • Pour que l'établissement soit actif et puisse exercer une activité sur notre plateforme, il doit avoir le statut : "ACTIVATED"
  • Pour passer au statut "ACTIVATED", il faut renseigner les informations suivantes :
    • legalStatus
    • address
    • supportingDocumentsID (fournir un document justifiant l'identité de l'entreprise)
    • companyInformation
    • avoir au moins une personne physique avec (statut = "ACTIVATED" et rôle = "ADMIN_PRO")
Array of objects (extensionAttribut)

Informations de l'entreprise (identité).

activities
Array of strings
Items Enum: "TRAVEL_SERVICE" "ACCOMMODATION_SERVICE"

Liste d'activités que l'établissemnt peux exercer :

  • pour les agences de voyages, le type est : TRAVEL_SERVICE
  • pour les établissements d'hébergement (hôtel, auberge, etc.), le type est : ACCOMMODATION_SERVICE

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "companyInformation": [
    ],
  • "activities": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "parentOrganism": "string",
  • "name": "string",
  • "legalStatus": "EI",
  • "address": {
    },
  • "supportingDocumentsID": "string",
  • "status": "MISSING_INFORMATIONS",
  • "companyInformation": [
    ],
  • "activities": [
    ]
}

deleteEstablishment

suppression d'un établissement.

path Parameters
establishment-id
required
string

id technique d'un organisme.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }