Modèle de données

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

Modèle de donnée d'une mission

Nom du champs	Type	Description
title	String	Titre de votre mission. Requis
description	String	La description de votre mission, peut contenir des balises HTML. 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
country	String	Code du pays de la mission
address	String	Adresse de la mission
city	String	Ville de la mission
postalCode	String	Code postal de la mission
departmentCode	String	Numéro de département de la mission
departmentName	String	Nom du département de la mission
region	String	Région de la mission
location	Object	Composé de lat et lon de type Number représentant la latitude et longitude de l'adresse de la mission
activity	String	Activité de la mission (cf. Les constantes)
domain	String	Domaine de la mission (cf. Les constantes)
schedule	String	Emploi du temps. "part_time" ou "full_time"
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. "possible", "full" ou "no"
reducedMobilityAccessible	String	Mission accessible pour les personnes à mobilité réduite. "yes" ou "no"
closeToTransport	String	Mission proche des transports en commun. "yes" ou "no"
openToMinors	String	Mission ouverte aux mineurs. "yes" ou "no"
priority	String	Priorité de la mission
tags	String[]	Ce champs permet de tagguer vos missions avec un mot-clé personnalisé dans l’API
metadata	String	Métadata de la mission
places	Number	Nombre de places de la mission
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

Les champs générés par l'API

L'API Engagement ajoute ensuite les champs suivants pour chaque mission

Nom du champ	Type	Description
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
lastSyncAt	Date	Date de début de la dernière mise à jour du flux
statusCode	String	Statut de modération de la mission. “ACCEPTED”ou “REFUSED”
statusComment	String	Commentaire du statut de la modération
createdAt	Date	Date de création de la mission dans l’API
updatedAt	Date	Date de création de la dernière mise à jour de la mission
deleted	Boolean	Si la mission est effacée. Défaut false
deletedAt	Date	Date à laquelle la mission à été effacée. Défaut null
duration	String	Durée de la mission, soit la difference entre startAt et endAt
descriptionHtml	String	Description originale contenant possiblement des balises HTML

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 /mymission:

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 moderation

// 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"
}