- MenagePublic
  - get Etat de l'application
  - get Consulter les informations d'un ménage
  - put Modifier les informations d'un ménage
  - get Consulter les informations d'une personne
  - put Modifier les informations d'une personne
  - post Ajouter un projet résidentiel et d'accompagnement à des personnes

API docs by Redocly

# SISIAO - API MENAGE (1.1.0)

Download OpenAPI specification:

API du SI-SIAO pour la gestion des MENAGE

## MenagePublic

API du module MENAGE SISIAO

## Etat de l'application

API permettant de visualiser l'état de fonctionnement du module MENAGE de l'application SIAO MENAGE

### Responses

/public/v1/healthcheck

### Response samples

- 200
- 401
- 500

Content type
application/json
`
{

- "version": "version",
- "status": true

}`

## Consulter les informations d'un ménage

##### path Parameters

cleMenage required | string <= 36 characters Clé SISIAO du ménage

##### header Parameters

tracabiliteIdentite required | string <byte> Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

### Responses

/public/v1/menages/{cleMenage}/socle3

### Response samples

- 200
- 400
- 401
- 403
- 404
- 500

Content type
application/json
`
{

- "menage": null,
- "personnes":
  [
  - {
    - "dateDeNaissance": "2000-01-23",
    - "codeSexeDeclare": "codeSexeDeclare",
    - "nomDUsage": "nomDUsage",
    - "clePersonne": "clePersonne",
    - "nomDeNaissance": "nomDeNaissance",
    - "prenom": "prenom"
    },
  - {
    - "dateDeNaissance": "2000-01-23",
    - "codeSexeDeclare": "codeSexeDeclare",
    - "nomDUsage": "nomDUsage",
    - "clePersonne": "clePersonne",
    - "nomDeNaissance": "nomDeNaissance",
    - "prenom": "prenom"
    }
  ]

}`

## Modifier les informations d'un ménage

##### path Parameters

cleMenage required | string <= 36 characters Clé SISIAO du ménage

##### header Parameters

tracabiliteIdentite required | string <byte> Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

##### Request Body schema: application/json
required

required | object (MenageInformations)

### Responses

/public/v1/menages/{cleMenage}/socle3

### Request samples

- Payload

Content type
application/json
`
{

- "menage":
  {
  - "codeTypologieDuMenage": "codeTypologieDuMenage",
  - "dateDerniereEvaluationFlash": "2000-01-23",
  - "cleMenage": "cleMenage",
  - "animalDeCompagnie":
    {
    - "type":
      [
      - {
        - "codeTypeAnimal": "codeTypeAnimal",
        - "nombre": 6
        },
      - {
        - "codeTypeAnimal": "codeTypeAnimal",
        - "nombre": 6
        }
      ]
    },
  - "adresseLieuDeVie":
    {
    - "libelleVoie": "libelleVoie",
    - "ville": "ville",
    - "codePostal": "codePostal"
    },
  - "version": 0
  }

}`

### Response samples

- 200
- 400
- 401
- 403
- 404
- 409
- 500

Content type
application/json
`
{

- "version": 0

}`

## Consulter les informations d'une personne

##### path Parameters

clePersonne required | string <= 36 characters Clé SISIAO de la personne

##### header Parameters

tracabiliteIdentite required | string <byte> Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

### Responses

/public/v1/personnes/{clePersonne}/socle3

### Response samples

- 200
- 400
- 401
- 403
- 404
- 500

Content type
application/json
`
{

- "personne": null

}`

## Modifier les informations d'une personne

##### path Parameters

clePersonne required | string <= 36 characters Clé SISIAO de la personne

##### header Parameters

tracabiliteIdentite required | string <byte> Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

##### Request Body schema: application/json
required

required | object (PersonneSocle3_personne)

### Responses

/public/v1/personnes/{clePersonne}/socle3

### Request samples

- Payload

Content type
application/json
`
{

- "personne": null

}`

### Response samples

- 200
- 400
- 401
- 403
- 404
- 409
- 500

Content type
application/json
`
{

- "version": 0

}`

## Ajouter un projet résidentiel et d'accompagnement à des personnes

##### path Parameters

cleMenage required | string <= 36 characters Clé SISIAO du ménage

##### header Parameters

tracabiliteIdentite required | string <byte> Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

##### Request Body schema: application/json
required

personnes required | Array of strings[ items <= 36 characters ] Liste des clés SISIAO des personnes concernées par le projet résidentiel et d'accompagnement
required | object (RapportSocial)
| object (BesoinsAccompagnement)
| object (ProjetResidentiel)

### Responses

/public/v1/menages/{cleMenage}/besoinsResidentielsAccompagnement

### Request samples

- Payload

Content type
application/json
`
{

- "projetResidentiel":
  {
  - "projetResidentiel": "projetResidentiel"
  },
- "rapportSocial":
  {
  - "rapportSocial": "rapportSocial"
  },
- "personnes":
  [
  - "personnes",
  - "personnes"
  ],
- "besoinsAccompagnement":
  {
  - "souhaitAccompagnementMenage": "souhaitAccompagnementMenage"
  }

}`

### Response samples

- 200
- 400
- 401
- 403
- 404
- 500

Content type
application/json
`
{

- "cleBesoinResidentielAccompagnement": "cleBesoinResidentielAccompagnement",
- "version": 0

}`