SISIAO - API MENAGE (0.1.0)

Download OpenAPI specification:Download

API du SI-SIAO pour la gestion des MENAGE

MenagePublic

Etat de l'application

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

Responses

Response samples

200

Content type

application/json

{"version": "string",
"status": true
}

Consulter les informations d'un ménage socle 1, 2 et 3

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

Response samples

Content type

application/json

{"personnes": [{"clePersonne": "string",
"nomDUsage": "string",
"nomDeNaissance": "string",
"prenom": "string",
"codeSexeDeclare": "string",
"dateDeNaissance": "2019-08-24"
}
],
"menage": {"cleMenage": "string",
"version": 0,
"codeTypologieDuMenage": "string",
"contactPrincipal": {"clePersonne": "string",
"nomDUsage": "string",
"nomDeNaissance": "string",
"prenom": "string",
"telephone": "string",
"email": "user@example.com"
},
"adresseLieuDeVie": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
},
"animalDeCompagnie": {"type": [{"codeTypeAnimal": "string",
"nombre": 0
}
]
},
"dateDerniereEvaluationFlash": "2019-08-24"
}
}

Modifier les informations d'un ménage Socle 1, 2 et 3

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

Request samples

Payload

Content type

application/json

{"menage": {"cleMenage": "string",
"version": 0,
"codeTypologieDuMenage": "string",
"contactPrincipal": {"clePersonne": "string",
"nomDUsage": "string",
"nomDeNaissance": "string",
"prenom": "string",
"telephone": "string",
"email": "user@example.com"
},
"adresseLieuDeVie": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
},
"animalDeCompagnie": {"type": [{"codeTypeAnimal": "string",
"nombre": 0
}
]
},
"dateDerniereEvaluationFlash": "2019-08-24"
}
}

Response samples

Content type

application/json

{"uuid": "string",
"codeErreur": "string",
"messageErreur": "string",
"path": "string",
"timestamp": "2019-08-24T14:15:22Z"
}

Consulter les informations d'une personne Socle 1, 2 et 3

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

Response samples

Content type

application/json

{"personne": {"clePersonne": "string",
"identifiantINS": "string",
"version": 0,
"etatCivil": {"nomDUsage": "string",
"nomDeNaissance": "string",
"prenom": "string",
"codeSexeDeclare": "string",
"dateDeNaissance": "2019-08-24",
"codeSituationMatrimoniale": "string"
},
"telephone": "string",
"email": "string",
"adresseDomiciliation": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
},
"adresseMaraude": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
},
"suiviPersonne": [{"codeTypeDeSuivi": "string",
"codeSousTypeDeSuivi": "string",
"dispositif": "string",
"nomDuReferent": "string",
"telephoneDuReferent": "string",
"mailDuReferent": "user@example.com"
}
],
"derniereSituationLogementConnue": {"codeSituationResidentielleNiveau1": "string",
"codeSituationResidentielleNiveau2": "string",
"dateDebutSituation": "2019-08-24",
"solidariteConjoint": true,
"codeMotifDesolidarisationConjoint": "string"
},
"situationAuRegardDuSejour": {"codeNationalite": "string",
"codeSituationSejour": "string",
"codeTitreSejour": "string",
"numeroAGDREF": "string",
"demandeRenouvellementTitreEnCours": true,
"enPossessionRecepisse": true,
"dateDemandeRenouvellementTitreSejour": "2019-08-24",
"conditionsMateriellesAccueil": "string",
"demandeDeTitreDeSejourEnCours": true,
"dateValiditeTitreSejour": "2019-08-24",
"enPossessionPieceIdentité": true,
"declarationPerte": true,
"dateArriveeEnFrance": "2019-08-24"
},
"droitsOuverts": [{"codeTypeDroit": "string"
}
],
"droitsOuvertsAssuranceMaladie": [{"codeDroitsOuvertsAssuranceMaladie": "string"
}
],
"demandeLogementSocial": {"demandeLogementSocialEnCours": true,
"numeroUniqueNUR": "string",
"datePremiereDemande": "2019-08-24",
"dateDernierRenouvellement": "2019-08-24",
"departementsSouhaites": ["str"
],
"villesSouhaitees": ["strin"
]
},
"syplo": {"codeInscriptionSyplo": "string",
"demandeActionLogementEnCours": true,
"numeroDossierDemande": "string"
},
"actionLogement": {"demandeActionLogementEnCours": true,
"numeroDossierDemande": "string"
},
"dalo": {"menageReconnuPrioritaireDALO": true,
"dateDeReconnaissanceDALO": "2019-08-24",
"dossierDeposeDALO": true,
"dateDepotDossierDALO": "2019-08-24"
},
"daho": {"menageReconnuPrioritaireDAHO": true,
"dateDeReconnaissanceDAHO": "2019-08-24",
"dossierDeposeDAHO": true,
"dateDepotDossierDAHO": "2019-08-24"
},
"occupation": {"emploi": {"enEmploi": true,
"codeTypeEmploi": "string",
"codeTypeTempsTravail": "string",
"horairesDecales": true,
"dateDebutDeContrat": "2019-08-24",
"dateFinDeContrat": "2019-08-24",
"adresseEmploi": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
}
},
"rechercheEmploi": {"enRechercheEmploi": true
},
"chomage": {"auChomage": true,
"codeStatutDuDemandeurFranceTravail": "string"
},
"retraite": true,
"inactifDiversHorsRetraite": true,
"rqth": true,
"formationScolaire": {"enFormationScolaire": true
},
"activiteDuMineur": {"codeActiviteMineur": "string",
"nomEtablissementOccupationMineur": "string",
"adresseEtablissementOccupationMineur": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
}
}
},
"situationFinanciere": [{"ligneSituationFinanciere": {"codeTypeSituationFinanciere": "string",
"codeSousTypeSituationFinanciere": "string",
"montantMensuel": 0
}
}
],
"autresInformationsComplémentaires": {"dossierSurendettementDepose": true,
"dateDepotDossier": "2019-08-24"
},
"grosesse": {"grossesse": true,
"codeTypeGrossese": "string",
"dateDuTerme": "2019-08-24"
},
"victimeDeViolence": {"victimeDeViolence": true,
"codeTypeViolence": ["string"
]
},
"sante": {"personneAMobiliteReduite": true,
"personneEnFauteuilRoulant": true
}
}
}

Modifier les informations d'une personne Socle 1, 2 et 3

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

object

Responses

Request samples

Payload

Content type

application/json

{"personne": {"clePersonne": "string",
"identifiantINS": "string",
"version": 0,
"etatCivil": {"nomDUsage": "string",
"nomDeNaissance": "string",
"prenom": "string",
"codeSexeDeclare": "string",
"dateDeNaissance": "2019-08-24",
"codeSituationMatrimoniale": "string"
},
"telephone": "string",
"email": "string",
"adresseDomiciliation": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
},
"adresseMaraude": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
},
"suiviPersonne": [{"codeTypeDeSuivi": "string",
"codeSousTypeDeSuivi": "string",
"dispositif": "string",
"nomDuReferent": "string",
"telephoneDuReferent": "string",
"mailDuReferent": "user@example.com"
}
],
"derniereSituationLogementConnue": {"codeSituationResidentielleNiveau1": "string",
"codeSituationResidentielleNiveau2": "string",
"dateDebutSituation": "2019-08-24",
"solidariteConjoint": true,
"codeMotifDesolidarisationConjoint": "string"
},
"situationAuRegardDuSejour": {"codeNationalite": "string",
"codeSituationSejour": "string",
"codeTitreSejour": "string",
"numeroAGDREF": "string",
"demandeRenouvellementTitreEnCours": true,
"enPossessionRecepisse": true,
"dateDemandeRenouvellementTitreSejour": "2019-08-24",
"conditionsMateriellesAccueil": "string",
"demandeDeTitreDeSejourEnCours": true,
"dateValiditeTitreSejour": "2019-08-24",
"enPossessionPieceIdentité": true,
"declarationPerte": true,
"dateArriveeEnFrance": "2019-08-24"
},
"droitsOuverts": [{"codeTypeDroit": "string"
}
],
"droitsOuvertsAssuranceMaladie": [{"codeDroitsOuvertsAssuranceMaladie": "string"
}
],
"demandeLogementSocial": {"demandeLogementSocialEnCours": true,
"numeroUniqueNUR": "string",
"datePremiereDemande": "2019-08-24",
"dateDernierRenouvellement": "2019-08-24",
"departementsSouhaites": ["str"
],
"villesSouhaitees": ["strin"
]
},
"syplo": {"codeInscriptionSyplo": "string",
"demandeActionLogementEnCours": true,
"numeroDossierDemande": "string"
},
"actionLogement": {"demandeActionLogementEnCours": true,
"numeroDossierDemande": "string"
},
"dalo": {"menageReconnuPrioritaireDALO": true,
"dateDeReconnaissanceDALO": "2019-08-24",
"dossierDeposeDALO": true,
"dateDepotDossierDALO": "2019-08-24"
},
"daho": {"menageReconnuPrioritaireDAHO": true,
"dateDeReconnaissanceDAHO": "2019-08-24",
"dossierDeposeDAHO": true,
"dateDepotDossierDAHO": "2019-08-24"
},
"occupation": {"emploi": {"enEmploi": true,
"codeTypeEmploi": "string",
"codeTypeTempsTravail": "string",
"horairesDecales": true,
"dateDebutDeContrat": "2019-08-24",
"dateFinDeContrat": "2019-08-24",
"adresseEmploi": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
}
},
"rechercheEmploi": {"enRechercheEmploi": true
},
"chomage": {"auChomage": true,
"codeStatutDuDemandeurFranceTravail": "string"
},
"retraite": true,
"inactifDiversHorsRetraite": true,
"rqth": true,
"formationScolaire": {"enFormationScolaire": true
},
"activiteDuMineur": {"codeActiviteMineur": "string",
"nomEtablissementOccupationMineur": "string",
"adresseEtablissementOccupationMineur": {"libelleVoie": "string",
"codePostal": "strin",
"ville": "string"
}
}
},
"situationFinanciere": [{"ligneSituationFinanciere": {"codeTypeSituationFinanciere": "string",
"codeSousTypeSituationFinanciere": "string",
"montantMensuel": 0
}
}
],
"autresInformationsComplémentaires": {"dossierSurendettementDepose": true,
"dateDepotDossier": "2019-08-24"
},
"grosesse": {"grossesse": true,
"codeTypeGrossese": "string",
"dateDuTerme": "2019-08-24"
},
"victimeDeViolence": {"victimeDeViolence": true,
"codeTypeViolence": ["string"
]
},
"sante": {"personneAMobiliteReduite": true,
"personneEnFauteuilRoulant": true
}
}
}

Response samples

Content type

application/json

{"uuid": "string",
"codeErreur": "string",
"messageErreur": "string",
"path": "string",
"timestamp": "2019-08-24T14:15:22Z"
}

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
version	integer <int64> Version de l'objet (timestamp) connu du système appelant - ne pas renseigner dans le cas d'une création
required	object (RapportSocial)
required	object (BesoinsAccompagnement)
	object (ProjetResidentiel)

Responses

Request samples

Payload

Content type

application/json

{"personnes": ["string"
],
"version": 0,
"rapportSocial": {"rapportSocial": "string"
},
"besoinsAccompagnement": {"souhaitAccompagnementMenage": "string",
"besoinsAccompagnementIdentifie": [{"codeTypeBesoinAccompagnementIdentifie": "string",
"codeSousTypeBesoinAccompagnementIdentifie": "string"
}
]
},
"projetResidentiel": {"projetResidentiel": "string",
"projetResidentielIdentifie": [{"codeConfigurationPhysique": "string",
"raisonsDeNonAccesLogement": "string"
}
]
}
}

Response samples

Content type

application/json

{"cleBesoinResidentielAccompagnement": "string",
"version": 0
}

SISIAO - API MENAGE (0.1.0)

MenagePublic

Etat de l'application

Responses

Response samples

Consulter les informations d'un ménage socle 1, 2 et 3

path Parameters

header Parameters

Responses

Response samples

Modifier les informations d'un ménage Socle 1, 2 et 3

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Consulter les informations d'une personne Socle 1, 2 et 3

path Parameters

header Parameters

Responses

Response samples

Modifier les informations d'une personne Socle 1, 2 et 3

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

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

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required