Modèle de données d'une mission d'engagement

Cette page décrit le modèle de données d'une mission envoyée ou récupérée sur l'API

Champs principaux

Nom du champs	Type	Description
title	String	Titre de votre mission. Requis
clientId	String	Identifiant de la mission. Requis
applicationUrl	String	Lien de candidature de la mission. Requis
postedAt	Date	Date à laquelle la mission a été postée. Défaut now()
startAt	Date	Date de début de la mission. Défaut now()
endAt	Date	Date de fin de la mission

Caractéristiques de la mission

Nom du champs	Type	Description
description	String	La description de votre mission, peut contenir des balises HTML. Requis
activity	String	Activité de la mission. 1 valeurs possible parmi : "environnement", "solidarite-insertion", "prevention-protection", "sante", "culture-loisirs", "education", "emploi", "sport", "humanitaire", "animaux", "vivre-ensemble", "autre", "mémoire et citoyenneté", ou "benevolat-competences"
domain	String	Domaine de la mission. 1 valeurs possible parmi : "taches-administratives", "conseil", "collecte", "informatique", "logistique", "mission-internationale", "alphabetisation", "jardinage", "animation", "communication", "aide-psychologique", "activites-manuelles", "encadrement-d-equipes", "bricolage", "sante-soins", "visites", "distribution", "soutien-scolaire", "documentation-traduction", "gestion-recherche-des-partenariats", "ecoute-permanence", "recrutement", "responsabilites-associatives", "juridique", "accueil-de-public", "enseignement-formation", "comptabilite-finance", "secourisme", "gestion-de-projets", "mentorat-parrainage", "sport", "art" ou "autre"
domainLogo	String	Lien url utilisable sur votre site pour illustrer la mission.
schedule	String	Rythme de la mission. Exemple : "1 demi-journée par semaine"
audience	String[]	Les bénéficiaires de la mission
soft_skills	String[]	Les compétences générales requises pour la mission
remote	String	Mission disponible en distanciel. Valeurs possibles: "possible", "full" ou "no"
reducedMobilityAccessible	String	Mission accessible pour les personnes à mobilité réduite. Valeurs possibles: "yes" ou "no"
closeToTransport	String	Mission proche des transports en commun. Valeurs possibles: "yes" ou "no"
openToMinors	String	Mission ouverte aux mineurs. Valeurs possibles: "yes" ou "no"
priority	String	Priorité de la mission
tags	String[]	Ce champs permet de tagguer vos missions avec un, ou plusieurs mots-clés personnalisés séparés par une virgule, dans l’API. Exemple 1: "Ecologie" Exemple 2: "Ecologie, Sport, Solidarité"
metadata	String	Métadata de la mission
places	Number	Nombre de places de la mission

Champs géographiques de la mission

Il s’agit de l’ensemble des localisations où se déroulent la mission :

• Si les missions se tiennent dans plusieurs lieux alors ces localisations se trouveront dans le champs addresses qui est un tableau d'objects contenant le détail géographique de chaque mission.

• Si vos missions ne se tiennent dans un lieu unique, vous ne renseignez qu'une seule adresse dans le tableau addresses.

• Dans le cas où la mission n'a aucune adresse (cas notamment des missions à distance /remote), ce tableau sera vide.

Exemple d'une mission avec une adresse unique

{
  "addresses": [
    {
      "street": "10 rue de la Paix",
      "city": "Paris",
      "postalCode": "75001",
      "departmentName": "Paris",
      "departmentCode": "75",
      "region": "Île-de-France",
      "country": "FR",
      "location": {
        "lat": 48.8698,
        "lon": 2.3322
      },
      "_id": "67b5d2814870a4e36c06edde"
    }
  ]
}

Exemple d'une mission avec plusieurs adresses

{
  "addresses": [
    {
      "street": "10 rue de la Paix",
      "city": "Paris",
      "postalCode": "75001",
      "departmentName": "Paris",
      "departmentCode": "75",
      "region": "Île-de-France",
      "country": "FR",
      "location": {
        "lat": 48.8698,
        "lon": 2.3322
      },
      "_id": "67b5d2814870a4e36c06edde"
    },
    {
      "street": "20 rue Victor Hugo",
      "city": "Lille",
      "postalCode": "59000",
      "departmentName": "Nord",
      "departmentCode": "59",
      "region": "Hauts-de-France",
      "country": "FR",
      "location": {
        "lat": 50.6292,
        "lon": 3.0573
      },
      "_id": "67b5d2814870a4e36c06ede0"
    }
  ]
}

Nom du champ	Type	Description
addresses	Array of Address	Tableau des adresses où se déroulent la mission. Chaque objet représente une adresse distincte. Veuillez vous référer au tableau ci-dessous ⬇️

Une adresse se compose des champs suivants :

Nom du champs	Type	Description
street	String	Rue où se déroule la mission. Exemple: 46 Rue Saint-Antoine
city	String	Ville où se déroule la mission Exemple: Paris
postalCode	String	Code postal où se déroule la mission Exemple: 75004
departmentCode	String	Numéro de département où se déroule la mission. Exemple: 75
departmentName	String	Nom du département où se déroule la mission
region	String	Région où se déroule la mission
location	Object	Composé de lat et lon de type Number représentant la latitude et longitude de l'adresse de la mission

Champs de l'organisation ou de la structure d'accueil

Nom du champs	Type	Description
organizationName	String	Nom de l'organisation de la mission
organizationRNA	String	RNA de l'organisation de la mission Requis (ou organizationSiren)
organizationSiren	String	Siren de l'organisation de la mission Requis (ou organizationRNA)
organizationUrl	String	Lien de l'organisation de la mission
organizationLogo	String	Lien de l'image de l'organisation de la mission
organizationDescription	String	Description de l'organisation de la mission
organizationClientId	String	Identifiant de l'organisation de la mission
organizationStatusJuridique	String	Statut juridique de l'organisation de la mission
organizationType	String	Type de l'organisation de la mission
organizationActions	String[]	Actions de l'organisation de la mission
organizationId	String	identifiant de l'organisation de la mission
organizationFullAddress	String	Adresse de l'organisation de la mission
organizationPostCode	String	Code postal de l'organisation de la mission
organizationCity	String	Ville de l'organisation de la mission
organizationBeneficiaries	String[]	Bénéficiaires de l'organisation de la mission
organizationReseaux	String[]	Réseau de l'organisation de la mission

Champs vérifiés et ajoutés par l'API Engagement

1. L'API Engagement les champs suivants pour chaque mission reçue :

Nom du champs	Type	Description
createdAt	Date	Date de création de la mission dans l’API
deletedAt	Date	Date à laquelle la mission à été effacée. Défaut null
deleted	Boolean	Si la mission est effacée. Défaut false
descriptionHtml	String	Description originale contenant possiblement des balises HTML
duration	String	Durée de la mission, soit la difference entre startAt et endAt
_id	String	Identifiant de la mission
lastSyncAt	Date	Date de début de la dernière mise à jour du flux
publisherId	String	Id du partenaire (vous) annonceur de la mission
publisherName	String	Nom du partenaire (vous) annonceur de la mission
publisherUrl	String	URL du partenaire (vous) annonceur de la mission
publisherLogo	String	Logo du partenaire (vous) annonceur de la mission
statusCode	String	Statut de modération de la mission.“ACCEPTED”ou “REFUSED”
statusComment	String	Commentaire du statut de la modération
updatedAt	Date	Date de création de la dernière mise à jour de la mission

1. L'API Engagement vérifie les références des organisations lors de l'import des missions des partenaires annonceurs afin de garantir l'exactitude des données.

Ce processus repose sur une base de données interne d'organisations, mise à jour mensuellement avec les données officielles de l'INSEE ainsi que sur un appel vers l'API Data Subvention pour validation externe si nécessaire.

L'API Engagement tente d'associer le RNA ou SIRET fourni par le partenaire annonceur avec une organisation existante dans la base de données interne. En cas d'absence de correspondance interne, l'API Engagement interroge l'API Data Subvention pour valider les informations de l'organisation. si une correspondance est trouvée et validée, l'organisation est créée dans la base interne avec les informations validées.

Nom du champs	Type	Description
organizationVerificationStatus	String	Statut de la vérification de l'organisation.
organizationRNAVerified	String	Numéro RNA de l'organisation vérifié
organizationSiretVerified	String	Numéro SIRET de l'organisation vérifié
organizationSirenVerified	String	Numéro SIREN de l'organisation vérifié
organizationNameVerified	String	Nom de l'organisation vérifié
organizationAddressVerified	String	Adresse de l'organisation vérifiée
organizationCityVerified	String	Ville de l'organisation vérifié
organizationPostalCodeVerified	String	Code postal de l'organisation vérifié
organizationDepartementCodeVerified	String	Code du département de l'organisation vérifié
organizationDepartementNameVerified	String	Nom du département de l'organisation vérifié
organizationRegionVerified	String	Nom de la région de l'organisation vérifié
organisationIsRUP	Boolean	Organisation reconnue d'utilité publique

Modération des partenaires "diffuseur"

Certains diffuseurs de l'API Engagement pratique une modération supplémentaire pour les missions qu'il récupèrent via l'API avant de les diffuser sur leur plateforme.

Dans ce cas, des champs supplémentaires sont ajoutés aux missions afin de connaître le statut de la modération. Tous ces champs suivent le format moderation_{identifiant_du_diffuseur}_{champs} comme suit et sont accessible par API avec la route :

Nom du champ	Type	Description
moderation_{id}_status	String	Statut de la modération parmi ces valeurs 👍 ACCEPTED: mission acceptée REFUSED: mission refusée PENDING: mission en attente de modération ONGOING: mission en cours de modération
moderation_{id}_comment	String	Motif du refus si la mission est refusée
moderation_{id}_title	String	Si le titre est modifié, nouveau titre choisi par le partenaire

Ces informations sont également visibles dans le dashboard "Partager des Missions" > Flux de Mission

Exemple de modération

// Mission refusée
{
    "title": "La meilleure mission de bénévolat",
    "startAt": "2012-12-21T00:00:00.000Z"
    ...
    "moderation_5f5931496c7ea5xxxxxxxxxx_comment": "La mission est refusée car la date de création est trop ancienne (> 6 mois)",
    "moderation_5f5931496c7ea5xxxxxxxxxx_status": "REFUSED",
    "moderation_5f5931496c7ea5xxxxxxxxxx_title": ""
}
// Mission acceptée
{
        "title": "La meilleure mission de bénévolat",
    ...
    "moderation_5f5931496c7eaxxxxxxxxxxx_comment": "",
    "moderation_5f5931496c7eaxxxxxxxxxxx_status": "ACCEPTED",
    "moderation_5f5931496c7eaxxxxxxxxxxx_title": "L'une des meilleures mission de bénévolat"
}