210 lines
7.6 KiB
JSON
210 lines
7.6 KiB
JSON
{
|
|
"$id": "https://entrouvert.com/ants-hub-push-schema.json",
|
|
"title": "Format du endpoint PUSH pour le HUB ANTS",
|
|
"type": "object",
|
|
"properties": {
|
|
"collectivites": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/$defs/collectivite"
|
|
}
|
|
}
|
|
},
|
|
"$defs": {
|
|
"collectivite": {
|
|
"type": "object",
|
|
"required": [
|
|
"id"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Identifiant de la collectivit\u00e9 \u00e0 la source (chrono)"
|
|
},
|
|
"nom": {
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "URL g\u00e9n\u00e9rale du portail de la collectivit\u00e9",
|
|
"$ref": "#/$defs/url"
|
|
},
|
|
"logo_url": {
|
|
"description": "URL du logo de la collectivit\u00e9",
|
|
"$ref": "#/$defs/url"
|
|
},
|
|
"rdv_url": {
|
|
"$ref": "#/$defs/url",
|
|
"description": "URL g\u00e9n\u00e9rique pour la prise de rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs our le URLs pour les lieux si elles sont absentes."
|
|
},
|
|
"gestion_url": {
|
|
"$ref": "#/$defs/url",
|
|
"description": "URL g\u00e9n\u00e9rique pour la gestion des rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs de gestion si elles sont absentes."
|
|
},
|
|
"annulation_url": {
|
|
"$ref": "#/$defs/url",
|
|
"description": "URL g\u00e9n\u00e9rique pour l'annulation des rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs d'annulation si elles sont absentes."
|
|
},
|
|
"lieux": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/$defs/lieu"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"type-rdv": {
|
|
"enum": [
|
|
"CNI",
|
|
"PASSPORT",
|
|
"CNI-PASSPORT",
|
|
"RETRIEVAL"
|
|
]
|
|
},
|
|
"lieu": {
|
|
"type": "object",
|
|
"required": [
|
|
"id"
|
|
],
|
|
"additionalProperties": false,
|
|
"dependentRequired": {
|
|
"latitude": [
|
|
"longitude"
|
|
],
|
|
"longitude": [
|
|
"latitude"
|
|
]
|
|
},
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Identifiant du lieu \u00e0 la source (chrono)"
|
|
},
|
|
"nom": {
|
|
"type": "string"
|
|
},
|
|
"numero_rue": {
|
|
"type": "string"
|
|
},
|
|
"code_postal": {
|
|
"type": "string"
|
|
},
|
|
"ville": {
|
|
"type": "string"
|
|
},
|
|
"longitude": {
|
|
"type": "number"
|
|
},
|
|
"latitude": {
|
|
"type": "number"
|
|
},
|
|
"url": {
|
|
"description": "URL g\u00e9n\u00e9rale du portail de la collectivit\u00e9 pour ce lieu",
|
|
"$ref": "#/$defs/url"
|
|
},
|
|
"rdv_url": {
|
|
"$ref": "#/$defs/url",
|
|
"description": "URL g\u00e9n\u00e9rique pour la prise de rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs si elles sont absentes"
|
|
},
|
|
"gestion_url": {
|
|
"$ref": "#/$defs/url",
|
|
"description": "URL g\u00e9n\u00e9rique pour la gestion des rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs de gestion si elles sont absentes"
|
|
},
|
|
"annulation_url": {
|
|
"$ref": "#/$defs/url",
|
|
"description": "URL g\u00e9n\u00e9rique pour l'annulation des rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs d'annulation si elles sont absentes"
|
|
},
|
|
"plages": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/$defs/plage"
|
|
}
|
|
},
|
|
"rdvs": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/$defs/rdv"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"plage": {
|
|
"type": "object",
|
|
"required": [
|
|
"date",
|
|
"types_rdv"
|
|
],
|
|
"additionalProperties": false,
|
|
"description": "Plage de rendez-vous disponibles",
|
|
"properties": {
|
|
"date": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"description": "Date de la plage, format YYYY-MM-DD"
|
|
},
|
|
"heure_debut": {
|
|
"type": "string",
|
|
"format": "time",
|
|
"description": "Heure de d\u00e9but de la plage format, HH:MM"
|
|
},
|
|
"heure_fin": {
|
|
"type": "string",
|
|
"format": "time",
|
|
"description": "Heure de fin de la plage format, HH:MM"
|
|
},
|
|
"duree": {
|
|
"type": "number",
|
|
"description": "Dur\u00e9e des rendez-vous en minutes enti\u00e8res"
|
|
},
|
|
"personnes": {
|
|
"type": "number",
|
|
"description": "Nombre maximum de personnes pour ces rendez-vous",
|
|
"minimum": 1,
|
|
"maximum": 4
|
|
},
|
|
"types_rdv": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/$defs/type-rdv"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"rdv": {
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"date"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Identifiant de la pr\u00e9-demande ANTS"
|
|
},
|
|
"date": {
|
|
"type": "string",
|
|
"format": "datetime",
|
|
"description": "Date du rendez-vous format YYYY-MM-DDTHH:MM:SS"
|
|
},
|
|
"annule": {
|
|
"type": "boolean",
|
|
"description": "Si vrai, indique que le rendez-vous a été annulé"
|
|
},
|
|
"gestion_url": {
|
|
"description": "URL optionnelle de gestion du rendez-vous, si absent l'URL du lieu ou de la collectivit\u00e9 est utilis\u00e9e",
|
|
"$ref": "#/$defs/url"
|
|
},
|
|
"annulation_url": {
|
|
"description": "URL optionnelle d'annulation du rendez-vous, si absent l'URL du lieu ou de la collectivit\u00e9 est utilis\u00e9e",
|
|
"$ref": "#/$defs/url"
|
|
}
|
|
}
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"format": "uri"
|
|
}
|
|
}
|
|
}
|