Guides pour RDV-Solidarités
  • Guides et ressources de RDV-Solidarités
  • Les guides d'utilisation
    • Pour les agents
      • Guide d'utilisation pour les agents
        • Compte et connexion
        • Fiches usagers
        • Notifications usagers
        • Notifications agents
        • Interface Agent
        • Status de rendez-vous
        • File d'attente
        • Fusionner les doublons
        • Annulation de Rendez-vous
        • FAQ
      • Comment démarrer sur RDV-solidarités ?
        • Comment se connecter ?
        • Effectuer le paramétrage
          • Votre organisation
          • Vos lieux
          • Vos agents
          • Vos motifs
          • Vos statistiques globales
        • Définir votre planning
          • Créer des plages d’ouverture
          • Créer et gérer les absences
        • Créer votre base d’usagers
          • Comment créer une fiche usager en charge ?
          • Comment créer une fiche usager proche ?
          • Comment consulter l’historique des rendez-vous d’un usager ?
          • Comment rechercher un usager dans la base usager ?
        • comment gérer ses rendez-vous ?
          • Comment accéder au calendrier d’un autre agent ?
          • Comment poser un rendez-vous ?
            • 1. Directement sur l’agenda de l’agent
            • 2. Recherche de tous les créneaux disponibles
          • Comment consulter et modifier le résumé d’un rendez-vous ?
        • RDV Collectifs
        • Comment se déconnecter ?
    • Pour les Conseillers Numériques
    • Pour une organisation
      • Permissions des agents
      • Suppression d'agent
    • Pour un territoire
      • Créer une organisation
      • Configuration Territoire
      • Sectorisation géographique
        • Logique détaillée de la sectorisation
        • Exemple 1 : Par commune et par organisation
        • Exemple 2 : Sectorisation par rue et par agent
  • Documentation Technique
    • Hébergement & sécurité
    • Interconnexions aperçues
    • API de requêtes
      • Généralités
      • Authentification
      • Usagers
      • Agents
      • Organisations
      • Absences
      • Motifs
    • API de notifications
      • Format des données
      • FAQ
      • Vérification de signature
      • Outlook
      • Microsoft Dynamics
      • Interconnexion par email et icalendar
    • Envoi de SMS
    • États de rendez-vous
  • Organisation d'équipe
    • Le rôle de la personne référente
    • Estimations
    • Data.insertion aka RDV-Insertion
    • Gouvernance
    • Réunions Référentes
      • Réunion référentes du 19 avril 2022
      • Réunion référentes du 12 avril 2022
      • Réunion référentes du 5 avril 2022
      • Réunion référentes du 29 mars 2022
      • Réunion référentes du 22 mars 2022
      • Réunion référentes du 15 mars 2022
      • Réunion référentes du 8 mars 2022
      • Atelier RGPD du 7 mars 2022
      • Réunion référentes du 1er mars 2022
      • Atelier RGPD du 24 février 2022
      • Réunion référentes du 22 février 2022
      • Réunion référentes du 15 février 2022
      • Réunion référentes du 8 février 2022
      • Réunion référentes du 1er février 2022
      • Réunion référentes du 25 janvier 2022
      • Réunion référentes du 18 janvier 2022
      • Réunion référentes du 11 janvier 2022
      • Réunion référentes du 4 janvier 2022
      • Réunion référentes du 14 décembre 2021
      • Réunion référentes du 7 décembre 2021
      • Réunion référentes du 30 novembre 2021
      • Réunion référentes du 16 novembre 2021
      • Réunion référentes du 9 novembre 2021
      • Réunion référentes du 2 novembre 2021
      • Atelier RDV Collectif du 29 octobre 2021
      • Réunion référentes du 26 octobre 2021
      • Réunion référentes du 19 octobre 2021
      • Réunion référentes du 12 octobre 2021
      • Réunion référentes du 5 octobre 2021
      • Réunion référentes du 28 septembre 2021
      • Réunion référentes du 21 septembre 2021
      • Réunion Référents du 25 mai 2021
      • Réunion référent.e du 11 mai 2021
      • Réunion référent.e du 4 mai 2021
      • Réunion référente du 27 avril 2021
      • Réunion référentes du 16 mars 2021
      • Réunion référents du mardi 16 février 2021
      • Réunion référentes du mardi 2 février 2021
      • Réunion Référents du 19 janvier 2021
      • Avant 2021
        • Réunion Référents du 24 novembre 2020
        • Réunion référentes 3 décembre 2019
        • Réunion référentes du 8 décembre 2020
  • Informations générales
    • Informations générales et légales
      • Conditions d’utilisation de la plateforme RDV-Solidarités
      • Mentions Légales
      • Politique de confidentialité
      • À propos de RDV-Solidarités
      • Outils de prise de rendez-vous
      • Liste des champs stockés dans la base de données
      • Point de situation de l'équipe au 23 avril 2021
      • Incidents
        • Incident du 17 décembre 2021
        • Incident du 1er octobre 2021
        • Incident du 29 septembre 2021
        • Incident de septembre 2021
        • Incident du 7 septembre 2021
        • Incident du 29 avril 2021
        • Incident du 17 mars 2021
    • Dernières nouveautés
      • Modifications de 2021
      • Modifications de 2020
Powered by GitBook
On this page
  • RDV
  • Plage d'ouverture
  • Indisponibilité
  • Usager
  1. Documentation Technique
  2. API de notifications

Format des données

RDV

{
  "data": {
    "id":2989,
    "address":"Avenue de Ségur, Paris, 75015",
    "agents":[
      {
        "id":368,
        "email":"difallahradia@gmail.com",
        "first_name":"Radia",
        "last_name":"DIFALLAH"
      }
    ],
    "cancelled_at":null,
    "collectif":false,
    "context":"",
    "created_by":"agent",
    "duration_in_min":30,
    "ends_at":"2022-04-21 11:00:00 +0200",
    "lieu": {
      "id":190,
      "address":"Avenue de Ségur, Paris, 75015",
      "name":"MDS Lapin75",
      "single_use":false
    },
    "max_participants_count":null,
    "motif": {
      "id":370,
      "category":null,
      "deleted_at":null,
      "location_type":"public_office",
      "name":"Consultation BCG",
      "reservable_online":true,
      "service_id":1
    },
    "name":null,
    "organisation": {
      "id":141,
      "email":null,
      "name":"HOCHE",
      "phone_number":"0143765489"
    },
    "starts_at":"2022-04-21 10:30:00 +0200",
    "status":"unknown",
    "users": [
      {
        "id":1464,
        "address":"3 Rue de la rue, la Ville, 13007",
        "address_details":null,
        "affiliation_number":"",
        "birth_date":null,
        "birth_name":null,
        "caisse_affiliation":null,
        "case_number":null,
        "created_at":"2022-02-28 22:19:35 +0100",
        "email":"bob@example.com",
        "family_situation":null,
        "first_name":"Bob",
        "invitation_accepted_at":null,
        "invitation_created_at":"2022-02-28 22:19:35 +0100",
        "last_name":"Example",
        "notify_by_email":true,
        "notify_by_sms":true,
        "number_of_children":null,
        "phone_number":"0699999999",
        "phone_number_formatted":"+33699999999",
        "responsible":null,
        "responsible_id":null,
        "user_profiles":null
      }
    ],
    "users_count":1,
    "uuid":"47216715-675e-4728-b22a-5079d14f0b8b"
  },
  "meta": {
    "model":"Rdv",
    "event":"created",
    "timestamp":"2022-04-19 21:32:32 +0200"
  }
}

Plage d'ouverture

{
  "data": {
    "id": 568,
    "agent": {
      "id": 294,
      "email": "vincent.parfait@pasdecalais.fr",
      "first_name": "Jean",
      "last_name": "Parfait"
    },
    "end_time": "18:00:00",
    "first_day": "2020-07-17",
    "ical": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:RDV Solidarités\r\nCALSCALE:GREGORIAN\r\nMETHOD:REQUEST\r\nBEGIN:VTIMEZONE\r\nTZID:Europe/Paris\r\nBEGIN:DAYLIGHT\r\nDTSTART:20200329T030000\r\nTZOFFSETFROM:+0100\r\nTZOFFSETTO:+0200\r\nRRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=3\r\nTZNAME:CEST\r\nEND:DAYLIGHT\r\nBEGIN:STANDARD\r\nDTSTART:20201025T020000\r\nTZOFFSETFROM:+0200\r\nTZOFFSETTO:+0100\r\nRRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10\r\nTZNAME:CET\r\nEND:STANDARD\r\nEND:VTIMEZONE\r\nBEGIN:VEVENT\r\nDTSTAMP:20200717T085543Z\r\nUID:plage_ouverture_568@RDV Solidarités\r\nDTSTART;TZID=Europe/Paris:20200717T160000\r\nDTEND;TZID=Europe/Paris:20200717T180000\r\nCLASS:PUBLIC\r\nDESCRIPTION:\r\nLOCATION:Rue du Commandant Lherminier 62700 Bruay-la-Buissière\r\nSUMMARY:RDV Solidarités test vt\r\nATTENDEE:mailto:vincent.parfait@pasdecalais.fr\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
    "ical_uid": "plage_ouverture_568@RDV Solidarités",
    "lieu": {
      "id": 10,
      "address": "Rue du Commandant Lherminier 62700 Bruay-la-Buissière",
      "name": "CCAS de Bruay-la-Buissière"
    },
    "motifs": [
      {
        "id": 320,
        "name": "Consultation BCG"
      }
    ],
    "organisation": {
      "id": 1,
      "departement": "62",
      "name": "MDS Lapins"
    },
    "rrule": null,
    "start_time": "16:00:00",
    "title": "test vt"
  },
  "meta": {
    "model": "PlageOuverture",
    "event": "created",
    "timestamp": "2020-07-17 10:55:43 +0200"
  }
}

Indisponibilité

{
    "data":{
        "id":2,
        "agent":{
            "id":1,
            "email":"martine@demo.rdv-solidarites.fr",
            "first_name":"Martine",
            "last_name":"Validay"
        },
        "end_day":"2022-03-25",
        "end_time":"18:00:00",
        "first_day":"2022-03-24",
        "ical":"BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:RDV Solidarités\r\nCALSCALE:GREGORIAN\r\nMETHOD:PUBLISH\r\nBEGIN:VTIMEZONE\r\nTZID:Europe/Paris\r\nBEGIN:DAYLIGHT\r\nDTSTART:20220327T030000\r\nTZOFFSETFROM:+0100\r\nTZOFFSETTO:+0200\r\nRRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=3\r\nTZNAME:CEST\r\nEND:DAYLIGHT\r\nBEGIN:STANDARD\r\nDTSTART:20211031T020000\r\nTZOFFSETFROM:+0200\r\nTZOFFSETTO:+0100\r\nRRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10\r\nTZNAME:CET\r\nEND:STANDARD\r\nEND:VTIMEZONE\r\nBEGIN:VEVENT\r\nDTSTAMP:20220315T204727Z\r\nUID:absence_2@RDV Solidarités\r\nDTSTART;TZID=Europe/Paris:20220324T090000\r\nDTEND;TZID=Europe/Paris:20220325T180000\r\nORGANIZER:mailto:secretariat-auto@rdv-solidarites.fr\r\nSUMMARY:RDV Solidarités Formation\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
        "ical_uid":"absence_2@RDV Solidarités",
        "organisation":{
            "id":1,
            "email":null,
            "name":"MDS Paris Nord",
            "phone_number":"0123456789"
        },
        "rrule":null,
        "start_time":"09:00:00",
        "title":"Formation"
    },
    "meta":{
        "model":"Absence",
        "event":"created",
        "timestamp":"2022-03-15 21:47:27 +0100"
    }
}

Usager

{
    "data": {
            "logement":"locataire",
            "notes":"Une remarque pour l'exemple",
            "organisation":{
                    "id":1,
                    "email":null,
                    "name":"MDS Paris Nord",
                    "phone_number":"0123456789"
            },
            "user":{
                    "id":10007,
                    "address":"2 La Place, Éperlecques, 62910, 62, Pas-de-Calais, Hauts-de-France",
                    "address_details":"appartement 31234",
                    "affiliation_number":"123456789",
                    "birth_date":"1970-03-12",
                    "birth_name":null,
                    "caisse_affiliation":"caf",
                    "case_number":"5498465789",
                    "created_at":"2022-03-15 21:27:58 +0100",
                    "email":"louis@yahoo.fr",
                    "family_situation":"divorced",
                    "first_name":"Louis",
                    "invitation_accepted_at":null,
                    "invitation_created_at":null,
                    "last_name":"Amstrong",
                    "notify_by_email":true,
                    "notify_by_sms":true,
                    "number_of_children":6,
                    "phone_number":"0699999999",
                    "phone_number_formatted":"+33699999999",
                    "responsible":null,
                    "responsible_id":null,
                    "user_profiles":null
            }
    },
    "meta":{
            "model":"UserProfile",
            "event":"updated",
            "timestmp":"2022-03-15 21:42:33 +0100"
    }
}
PreviousAPI de notificationsNextFAQ

Last updated 3 years ago