API docs by Redocly

Documentation de l'api personnsApi (1.0.0)

Download OpenAPI specification:Download

Terms of Service

Documentation et contrat d'interface pour l'api PersonsApi, l'api responsable de la géstion de personnes phisiques (part & pro) pour tout type de profile partenaire ou particulier.

Personnes

addPerson

création d'une personne au tant qu'objet métier.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
required
string

Identifiant technique généré par le serveur d'authentification , qui identifie une personne.

picture
string

lien vers La photo du profil.

lastName
string

Nom de famille d'une personne.

firstName
string

Prénom de famille d'une personne.

gender
string
Enum: "MALE" "FEMALE"

Sexe de la personne.

dateOfBirth
string <date>

Date de naissance de la personne.

email
required
string

L'adresse e-mail de la personne.

object (Téléphone)

Numéro de téléphone.

object (Adresse)

L'objet qui représente une adresse postale du bien à louer.

type
required
string
Enum: "PART" "PRO"

Type de personne.

status
string
Enum: "MISSING_INFORMATIONS" "ACTIVATED" "ACTIVATION_IN_PROGRESS"

Le statut de la personne physique.

  • Par défaut, une personne physique est créée avec le statut : "MISSING_INFORMATIONS".
  • Pour que la personne physique soit active et puisse exercer une activité sur notre plateforme, elle doit avoir le statut : "ACTIVATED"
  • Pour passer au statut "ACTIVATED", il faut renseigner les informations suivantes :
    • dateOfBirth
    • phoneNumber
    • address
operation
string
Enum: "CREATION" "INVITATION"

Enum indique si la création de personne est lancé dpuis une invitation par un autre utilisateur (PRO), ou parcours de création de compte normal

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "picture": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "gender": "MALE",
  • "dateOfBirth": "2019-08-24",
  • "email": "string",
  • "phoneNumber": {
    },
  • "address": {
    },
  • "type": "PART",
  • "status": "MISSING_INFORMATIONS",
  • "operation": "CREATION"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "picture": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "gender": "MALE",
  • "dateOfBirth": "2019-08-24",
  • "email": "string",
  • "phoneNumber": {
    },
  • "address": {
    },
  • "type": "PART",
  • "status": "MISSING_INFORMATIONS",
  • "operation": "CREATION",
  • "links": [
    ]
}

listPerson

Lister les personnes.

query Parameters
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.

attachmentIds
string
Example: attachmentIds=id1,id2,id3

Filtre par identifiants d'attachement (séparés par virgule)

personIds
string
Example: personIds=p1,p2,p3

Filtre par identifiants de personnes (séparés par virgule)

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

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

getPerson

récupération d'une personne par son id.

path Parameters
person-id
required
string

id technique du personne.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "picture": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "gender": "MALE",
  • "dateOfBirth": "2019-08-24",
  • "email": "string",
  • "phoneNumber": {
    },
  • "address": {
    },
  • "type": "PART",
  • "status": "MISSING_INFORMATIONS",
  • "operation": "CREATION",
  • "links": [
    ]
}

putPerson

modification d'une personne.

path Parameters
person-id
required
string

id technique du personne.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
required
string

Identifiant technique généré par le serveur d'authentification , qui identifie une personne.

picture
string

lien vers La photo du profil.

lastName
string

Nom de famille d'une personne.

firstName
string

Prénom de famille d'une personne.

gender
string
Enum: "MALE" "FEMALE"

Sexe de la personne.

dateOfBirth
string <date>

Date de naissance de la personne.

email
required
string

L'adresse e-mail de la personne.

object (Téléphone)

Numéro de téléphone.

object (Adresse)

L'objet qui représente une adresse postale du bien à louer.

type
required
string
Enum: "PART" "PRO"

Type de personne.

status
string
Enum: "MISSING_INFORMATIONS" "ACTIVATED" "ACTIVATION_IN_PROGRESS"

Le statut de la personne physique.

  • Par défaut, une personne physique est créée avec le statut : "MISSING_INFORMATIONS".
  • Pour que la personne physique soit active et puisse exercer une activité sur notre plateforme, elle doit avoir le statut : "ACTIVATED"
  • Pour passer au statut "ACTIVATED", il faut renseigner les informations suivantes :
    • dateOfBirth
    • phoneNumber
    • address
operation
string
Enum: "CREATION" "INVITATION"

Enum indique si la création de personne est lancé dpuis une invitation par un autre utilisateur (PRO), ou parcours de création de compte normal

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "picture": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "gender": "MALE",
  • "dateOfBirth": "2019-08-24",
  • "email": "string",
  • "phoneNumber": {
    },
  • "address": {
    },
  • "type": "PART",
  • "status": "MISSING_INFORMATIONS",
  • "operation": "CREATION"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "picture": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "gender": "MALE",
  • "dateOfBirth": "2019-08-24",
  • "email": "string",
  • "phoneNumber": {
    },
  • "address": {
    },
  • "type": "PART",
  • "status": "MISSING_INFORMATIONS",
  • "operation": "CREATION",
  • "links": [
    ]
}

deletePerson

suppression d'une personne.

path Parameters
person-id
required
string

id technique du personne.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }

activatePerson

Activer le compte d'une personne.

path Parameters
person-id
required
string

id technique du personne.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "picture": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "gender": "MALE",
  • "dateOfBirth": "2019-08-24",
  • "email": "string",
  • "phoneNumber": {
    },
  • "address": {
    },
  • "type": "PART",
  • "status": "MISSING_INFORMATIONS",
  • "operation": "CREATION",
  • "links": [
    ]
}

Favoris

addFavorites

enregistrer une entité en favoris.

path Parameters
person-id
required
string

id technique du personne.

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.

entityType
required
String (entityTypeFavoris)
Enum: "TRIP" "HOTE"

Type d'entité.

entityId
required
string

L'id de l'entité en question.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "entityType": "TRIP",
  • "entityId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entityType": "TRIP",
  • "entityId": "string",
  • "links": [
    ]
}

listFavorites

Lister les les favoris.

path Parameters
person-id
required
string

id technique du personne.

query Parameters
entityType
required
String (entityTypeFavoris)
Enum: "TRIP" "HOTE"

Type d'entité.

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": [
    ]
}

deleteFavorite

suppression d'une favoris.

path Parameters
person-id
required
string

id technique du personne.

favorite-id
required
string

id technique du favoris.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }

Attachments

addAttachment

enregistrer une entité en attachment.

path Parameters
person-id
required
string

id technique du personne.

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 rattachement entre un utilisateur et une entité.

entityType
string
Enum: "ORGANIZATION" "ESTABLISHMENT"

Type d'entité.

entityId
string

L'id de l'entité en question.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "entityType": "ORGANIZATION",
  • "entityId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "entityType": "ORGANIZATION",
  • "entityId": "string",
  • "links": [
    ]
}

listAttachments

Lister les attachements.

path Parameters
person-id
required
string

id technique du personne.

query Parameters
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": [
    ]
}

deleteAttachment

suppression d'une attachment

path Parameters
person-id
required
string

id technique du personne.

query Parameters
entity-id
required
string

id technique de l'entité d'attachement.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{ }