Gets an agreement by ID.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/agreements/112770

{
    "id": 112770,
    "name": "ACCORD COLLECTIF NATIONAL - BÂTIMENT ET TRAVAUX PUBLICS - COLLEGE CADRES - NON ETENDU",
    "risk": {
        "slug": "collective-foresight"
    },
    "_links": {
        "self": {
            "href": "/v1/collective-foresight/agreements/112770"
        }
    }
}

Gets the list of collective foresight agreements.

After getting the initial list, use the first, last, next, prev link relations in the _links property to get more agreements in the list. Note that next will not be available at the end of the list and prev will not be available at the start of the list. If the results are exactly one page neither prev nor next will be available.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-foresight/agreements

{
  "page": 1,
  "limit": 20,
  "pages": 55,
  "total": 1090,
  "_links": {
    "self": {
      "href": "/v1/collective-foresight/agreements?page=1&limit=20"
    },
    "first": {
      "href": "/v1/collective-foresight/agreements?page=1&limit=20"
    },
    "last": {
      "href": "/v1/collective-foresight/agreements?page=55&limit=20"
    },
    "next": {
      "href": "/v1/collective-foresight/agreements?page=2&limit=20"
    }
  },
  "_embedded": {
    "agreements": [
      {
        "id": 112770,
        "name": "ACCORD COLLECTIF NATIONAL - BÂTIMENT ET TRAVAUX PUBLICS - COLLEGE CADRES - NON ETENDU",
        "_links": {
          "self": {
            "href": "/v1/collective-foresight/agreements/112770"
          }
        }
      },
      [...]
    ]
  }
}

Retrieve a collective foresight agreement summary document.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Gets a collective foresight agreement by ID.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-foresight/agreements/59940

{
  "id": 59940,
  "name": "CONVENTION COLLECTIVE NATIONALE DU SERVICE DE L'AUTOMOBILE ",
  "_links": {
    "self": {
      "href": "/v1/collective-foresight/agreements/59940"
    },
    "convention": {
      "href": "/v1/conventions/61651"
    }
  },
  "_embedded": {
    "convention": {
      "id": 61651,
      "name": "Convention collective nationale des services de l'automobile (commerce et réparation de l'automobile, du cycle et du motocycle, activités connexes, contrôle technique automobile, formation des conducteurs auto-écoles CNPA )",
      "_links": {
        "self": {
          "href": "/v1/conventions/61651"
        },
        "parent": {
          "href": "/v1/conventions/66058"
        }
      },
      "_embedded": {
        "parent": {
          "id": 66058,
          "name": "ANI du 11 Janvier 2013",
          "_links": {
            "self": {
              "href": "/v1/conventions/66058"
            }
          }
        }
      }
    }
  }
}

Gets the list of collective foresight agreements by convention.

After getting the initial list, use the first, last, next, prev link relations in the _links property to get more agreements in the list. Note that next will not be available at the end of the list and prev will not be available at the start of the list. If the results are exactly one page neither prev nor next will be available.

Questions

You can submit questions and answers as filters (see the question service to retrieve the questions and the valid answers).

These filters are simple queries: e.g. ...?question_slug1=value1&question_slug2=&question_value3=value3

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-foresight/conventions/61651/agreements

        {
          "page": 1,
          "limit": 20,
          "pages": 1,
          "total": 3,
          "_links": {
            "self": {
              "href": "/v1/collective-foresight/conventions/61651/agreements?page=1&limit=20"
            },
            "first": {
              "href": "/v1/collective-foresight/conventions/61651/agreements?page=1&limit=20"
            },
            "last": {
              "href": "/v1/collective-foresight/conventions/61651/agreements?page=1&limit=20"
            }
          },
          "_embedded": {
            "agreements": [
              {
                "id": 59940,
                "name": "CONVENTION COLLECTIVE NATIONALE DU SERVICE DE L'AUTOMOBILE ",
                "_links": {
                  "self": {
                    "href": "/v1/collective-foresight/agreements/59940"
                  }
                }
              },
              {
                [...]
              }
            ]
          }
        }

Gets the list of collective foresight agreements by convention grouped by college.

Questions

You can submit questions and answers as filters (see the question service to retrieve the questions and the valid answers).

These filters are simple queries: e.g. ...?question_slug1=value1&question_slug2=&question_value3=value3

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-foresight/conventions/61651/agreements/groups

{
  "total": 3,
  "_links": {
    "self": {
      "href": "/v1/collective-foresight/conventions/61228/agreements/groups"
    }
  },
  "_embedded": {
    "groups": {
      "CA": {
        "name": "cadres",
        "includes_executives": true,
        "includes_non_executives": true,
        "colleges": [
          {
            "code": "CA",
            "name": "cadres"
          },
          {
            "code": "NC",
            "name": "non cadres"
          }
        ],
        "agreements": [
          {
            "id": 69527,
            "name": "RETRAITE ET PREVOYANCE DES CADRES - 14 MARS 1947",
            "_links": {
              "self": {
                "href": "/v1/collective-foresight/agreements/69527"
              }
            }
          }
        ]
      },
      ...
    }
  }
}

Gets the next collective foresight question.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-foresight/conventions/1/questions/next

{
  "answers": {
    "1997": "Transport sanitaire",
    "1998": "Transport de fonds et valeurs",
    "1999": "Transport routier de marchandises",
    "2000": "Transport routier de voyageurs",
    "2001": "Transport de déménagement",
    "2004": "autres secteurs",
    "2005": "confection administrative et militaire",
    "2008": "Manutention portuaire",
    "2009": "Gestionnaire de ports maritimes"
  },
  "slug": "job",
  "text": "Sous-métier",
  "_links": {
    "self": {
      "href": "/v1/collective-foresight/questions/job"
    }
  }
}

Gets the list of collective foresight questions.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-foresight/questions

{
  "total": 5,
  "_links": {
    "self": {
      "href": "/v1/collective-foresight/questions"
    }
  },
  "_embedded": {
    "questions": [
      {
        "slug": "job",
        "text": "Sous-métier",
        "_links": {
          "self": {
            "href": "/v1/collective-foresight/questions/job"
          }
        }
      },
      {
        "slug": "territory",
        "text": "Territoire",
        "_links": {
          "self": {
            "href": "/v1/collective-foresight/questions/territory"
          }
        }
      },
      {
        "slug": "college",
        "text": "Collège",
        "_links": {
          "self": {
            "href": "/v1/collective-foresight/questions/college"
          }
        }
      },
      {
        "slug": "syndicate",
        "text": "Syndicat",
        "_links": {
          "self": {
            "href": "/v1/collective-foresight/questions/syndicate"
          }
        }
      }
    ]
  }
}

Gets a collective foresight question by slug.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Filters

You can filter the question answers for a specific convention by specifying a convention ID as a simple query: e.g. ...?convention_id=A_VALID_ID

Body

Type: application/json

Example

GET /v1/collective-foresight/questions/job

{
  "answers": {
    "1997": "Transport sanitaire",
    "1998": "Transport de fonds et valeurs",
    "1999": "Transport routier de marchandises",
    "2000": "Transport routier de voyageurs",
    "2001": "Transport de déménagement",
    "2004": "autres secteurs",
    "2005": "confection administrative et militaire",
    "2008": "Manutention portuaire",
    "2009": "Gestionnaire de ports maritimes"
  },
  "slug": "job",
  "text": "Sous-métier",
  "_links": {
    "self": {
      "href": "/v1/collective-foresight/questions/job"
    }
  }
}

Gets the list of collective health agreements.

After getting the initial list, use the first, last, next, prev link relations in the _links property to get more agreements in the list. Note that next will not be available at the end of the list and prev will not be available at the start of the list. If the results are exactly one page neither prev nor next will be available.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-health/agreements

{
  "page": 1,
  "limit": 20,
  "pages": 16,
  "total": 318,
  "_links": {
    "self": {
      "href": "/v1/collective-health/agreements?page=1&limit=20"
    },
    "first": {
      "href": "/v1/collective-health/agreements?page=1&limit=20"
    },
    "last": {
      "href": "/v1/collective-health/agreements?page=16&limit=20"
    },
    "next": {
      "href": "/v1/collective-health/agreements?page=2&limit=20"
    }
  },
  "_embedded": {
    "agreements": [
      {
        "id": 210249,
        "name": "ACCORD NATIONAL - SCIERIES AGRICOLES ET EXPLOITATIONS FORESTIERES - COLLEGE NON CADRES - ETENDU",
        "_links": {
          "self": {
            "href": "/v1/collective-health/agreements/210249"
          }
        }
      },
      [...]
    ]
  }
}

Retrieve a collective health agreement summary document.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Gets a collective health agreement by ID.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-health/agreements/58472

{
  "id": 58472,
  "name": "SERVICES DE L'AUTOMOBILE",
  "_links": {
    "self": {
      "href": "/v1/collective-health/agreements/58472"
    },
    "convention": {
      "href": "/v1/conventions/61651"
    }
  },
  "_embedded": {
    "convention": {
      "id": 61651,
      "name": "Convention collective nationale des services de l'automobile (commerce et réparation de l'automobile, du cycle et du motocycle, activités connexes, contrôle technique automobile, formation des conducteurs auto-écoles CNPA )",
      "_links": {
        "self": {
          "href": "/v1/conventions/61651"
        },
        "parent": {
          "href": "/v1/conventions/66058"
        }
      },
      "_embedded": {
        "parent": {
          "id": 66058,
          "name": "ANI du 11 Janvier 2013",
          "_links": {
            "self": {
              "href": "/v1/conventions/66058"
            }
          }
        }
      }
    }
  }
}

Gets the list of collective health agreements by convention.

After getting the initial list, use the first, last, next, prev link relations in the _links property to get more agreements in the list. Note that next will not be available at the end of the list and prev will not be available at the start of the list. If the results are exactly one page neither prev nor next will be available.

Questions

You can submit questions and answers as filters (see the question service to retrieve the questions and the valid answers).

These filters are simple queries: e.g. ...?question_slug1=value1&question_slug2=&question_value3=value3

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-health/conventions/61651/agreements

{
  "page": 1,
  "limit": 20,
  "pages": 1,
  "total": 1,
  "_links": {
    "self": {
      "href": "/v1/collective-health/conventions/61651/agreements?page=1&limit=20"
    },
    "first": {
      "href": "/v1/collective-health/conventions/61651/agreements?page=1&limit=20"
    },
    "last": {
      "href": "/v1/collective-health/conventions/61651/agreements?page=1&limit=20"
    }
  },
  "_embedded": {
    "agreements": [
      {
        "id": 58472,
        "name": "SERVICES DE L'AUTOMOBILE",
        "_links": {
          "self": {
            "href": "/v1/collective-health/agreements/58472"
          }
        }
      }
    ]
  }
}

Gets the list of collective health agreements by convention grouped by college.

Questions

You can submit questions and answers as filters (see the question service to retrieve the questions and the valid answers).

These filters are simple queries: e.g. ...?question_slug1=value1&question_slug2=&question_value3=value3

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-health/conventions/61651/agreements/groups

{
  "total": 1,
  "_links": {
    "self": {
      "href": "/v1/collective-health/conventions/61228/agreements/groups"
    }
  },
  "_embedded": {
    "groups": {
      "EP": {
        "name": "ensemble du personnel",
        "includes_executives": true,
        "includes_non_executives": true,
        "colleges": [
          {
            "code": "CA",
            "name": "cadres"
          },
          {
            "code": "TAM",
            "name": "techniciens et agents de maitrise"
          },
          {
            "code": "EMPL",
            "name": "employés"
          },
          {
            "code": "OUVR",
            "name": "ouvriers"
          }
        ],
        "agreements": [
          {
            "id": 29629,
            "name": "TRANSPORT DE DEMENAGEMENT",
            "_links": {
              "self": {
                "href": "/v1/collective-health/agreements/29629"
              }
            }
          },
          {
            "id": 58426,
            "name": "TRANSPORT SANITAIRE",
            "_links": {
              "self": {
                "href": "/v1/collective-health/agreements/58426"
              }
            }
          },
          ...
        ]
      }
    }
  }
}

Gets the next collective health question.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-health/conventions/1/questions/next

{
  "answers": {
    "1997": "Transport sanitaire",
    "1998": "Transport de fonds et valeurs",
    "1999": "Transport routier de marchandises",
    "2000": "Transport routier de voyageurs",
    "2001": "Transport de déménagement",
    "2004": "autres secteurs",
    "2005": "confection administrative et militaire",
    "2008": "Manutention portuaire",
    "2009": "Gestionnaire de ports maritimes"
  },
  "slug": "job",
  "text": "Sous-métier",
  "_links": {
    "self": {
      "href": "/v1/collective-foresight/questions/job"
    }
  }
}

Gets the list of collective health questions.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-health/questions

{
  "total": 5,
  "_links": {
    "self": {
      "href": "/v1/collective-health/questions"
    }
  },
  "_embedded": {
    "questions": [
      {
        "slug": "job",
        "text": "Sous-métier",
        "_links": {
          "self": {
            "href": "/v1/collective-health/questions/job"
          }
        }
      },
      {
        "slug": "territory",
        "text": "Territoire",
        "_links": {
          "self": {
            "href": "/v1/collective-health/questions/territory"
          }
        }
      },
      {
        "slug": "college",
        "text": "Collège",
        "_links": {
          "self": {
            "href": "/v1/collective-health/questions/college"
          }
        }
      },
      {
        "slug": "syndicate",
        "text": "Syndicat",
        "_links": {
          "self": {
            "href": "/v1/collective-health/questions/syndicate"
          }
        }
      }
    ]
  }
}

Gets a collective health question by slug.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Filters

You can filter the question answers for a specific convention by specifying a convention ID as a simple query: e.g. ...?convention_id=A_VALID_ID

Body

Type: application/json

Example

GET /v1/collective-health/questions/job

{
  "answers": {
    "1997": "Transport sanitaire",
    "1998": "Transport de fonds et valeurs",
    "1999": "Transport routier de marchandises",
    "2000": "Transport routier de voyageurs",
    "2001": "Transport de déménagement",
    "2004": "autres secteurs",
    "2005": "confection administrative et militaire",
    "2008": "Manutention portuaire",
    "2009": "Gestionnaire de ports maritimes"
  },
  "slug": "job",
  "text": "Sous-métier",
  "_links": {
    "self": {
      "href": "/v1/collective-health/questions/job"
    }
  }
}

Gets the list of college.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/colleges

{
  "total": 3,
  "_links": {
    "self": {
      "href": "/v1/colleges"
    }
  },
  "_embedded": {
        "colleges": [
          {
            "code": "CA",
            "name": "cadres",
            "executive": true,
            "executive": false
          },
          {
            "code": "NC",
            "name": "non cadres",
            "executive": false,
            "executive": true
          }
        ]
      },
      ...
    }
  }
}

Gets the list of conventions.

After getting the initial list, use the first, last, next, prev link relations in the _links property to get more conventions in the list. Note that next will not be available at the end of the list and prev will not be available at the start of the list. If the results are exactly one page neither prev nor next will be available.

Filters

You can filter the conventions by type, national agreement type ID and APE code using simple query: e.g. ...?type=ACN&national_agreement_type_id=A_VALID_ID

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/conventions

{
  "page": 1,
  "limit": 20,
  "pages": 54,
  "total": 1066,
  "_links": {
    "self": {
      "href": "/v1/conventions?page=1&limit=20"
    },
    "first": {
      "href": "/v1/conventions?page=1&limit=20"
    },
    "last": {
      "href": "/v1/conventions?page=54&limit=20"
    },
    "next": {
      "href": "/v1/conventions?page=2&limit=20"
    }
  },
  "_embedded": {
    "conventions": [
      {
        "id": 65146,
        "idcc": "9998",
        "name": "___Convention non encore en vigueur___",
        "type": "CCN",
        "_links": {
          "self": {
            "href": "/v1/conventions/65146"
          }
        }
      },
      {
        "id": 65147,
        "idcc": "9999",
        "name": "___Sans convention collective___",
        "type": "CCN",
        "_links": {
          "self": {
            "href": "/v1/conventions/65147"
          }
        }
      },
      {
        [...]
      }
    ]
  }
}

Gets a convention by IDCC.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/conventions/@0016

{
  "id": 61228,
  "idcc": "0016",
  "name": "Convention collective nationale des transports routiers et activités auxiliaires du transport",
  "type": "CCN",
  "_links": {
    "self": {
      "href": "/v1/conventions/61228"
    },
    "parent": {
      "href": "/v1/conventions/66058"
    },
    "collective_foresight_agreements": {
      "href": "/v1/collective-foresight/conventions/61228/agreements"
    },
    "collective_health_agreements": {
      "href": "/v1/collective-health/conventions/61228/agreements"
    }
  },
  "_embedded": {
    "parent": {
      "id": 66058,
      "name": "ANI du 11 Janvier 2013",
      "type": "ANI",
      "_links": {
        "self": {
          "href": "/v1/conventions/66058"
        },
        "collective_foresight_agreements": {
          "href": "/v1/collective-foresight/conventions/66058/agreements"
        },
        "collective_health_agreements": {
          "href": "/v1/collective-health/conventions/66058/agreements"
        }
      }
    }
  }
}

Gets a convention by ID.

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/conventions/61228

{
  "id": 61228,
  "idcc": "0016",
  "name": "Convention collective nationale des transports routiers et activités auxiliaires du transport",
  "type": "CCN",
  "_links": {
    "self": {
      "href": "/v1/conventions/61228"
    },
    "parent": {
      "href": "/v1/conventions/66058"
    },
    "collective_foresight_agreements": {
      "href": "/v1/collective-foresight/conventions/61228/agreements"
    },
    "collective_health_agreements": {
      "href": "/v1/collective-health/conventions/61228/agreements"
    }
  },
  "_embedded": {
    "parent": {
      "id": 66058,
      "name": "ANI du 11 Janvier 2013",
      "type": "ANI",
      "_links": {
        "self": {
          "href": "/v1/conventions/66058"
        },
        "collective_foresight_agreements": {
          "href": "/v1/collective-foresight/conventions/66058/agreements"
        },
        "collective_health_agreements": {
          "href": "/v1/collective-health/conventions/66058/agreements"
        }
      }
    }
  }
}

Gets the list of collective health agreements by convention grouped by college.

Questions

You can submit questions and answers as filters (see the question service to retrieve the questions and the valid answers).

These filters are simple queries: e.g. ...?question_slug1=value1&question_slug2=&question_value3=value3

Request

Headers

authuser - required (string) - A valid token, provided by Profideo, must be provided for each request.

Body

Type: application/json

Example

GET /v1/collective-health,collective-foresight/conventions/62629/agreements/groups

{
  "total": 4,
  "_links": {
    "self": {
      "href": "/v1/collective-health,collective-foresight/conventions/62629/agreements/groups"
    }
  },
  "_embedded": {
    "groups": {
      "CA/TAM": {
        "name": "cadres (cadres, techniciens et agents de maitrise)",
        "includes_executives": true,
        "includes_non_executives": true,
        "colleges": [
          {
            "code": "CA",
            "name": "cadres"
          },
          {
            "code": "TAM",
            "name": "techniciens et agents de maitrise"
          }
        ],
        "agreements": {
          "collective-foresight": [
            {
              "id": 68902,
              "name": "CONVENTION COLLECTIVE NATIONALE - PHARMACIE D'OFFICINE",
              "_links": {
                "self": {
                  "href": "/v1/collective-foresight/agreements/68902"
                }
              }
            },
            {
              "id": 82602,
              "name": "CONVENTION COLLECTIVE NATIONALE - PHARMACIE D'OFFICINE",
              "_links": {
                "self": {
                  "href": "/v1/collective-foresight/agreements/82602"
                }
              }
            }
          ]
        }
      },
      "CA": {
        "name": "cadres",
        "includes_executives": true,
        "includes_non_executives": false,
        "colleges": [
          {
            "code": "CA",
            "name": "cadres"
          }
        ],
        "agreements": {
          "collective-health": [
            {
              "id": 61167,
              "name": "PHARMACIE D'OFFICINE",
              "_links": {
                "self": {
                  "href": "/v1/collective-health/agreements/61167"
                }
              }
            },
            {
              "id": 79826,
              "name": "PHARMACIE D'OFFICINE",
              "_links": {
                "self": {
                  "href": "/v1/collective-health/agreements/79826"
                }
              }
            }
          ],
          "collective-foresight": [
            {
              "id": 68897,
              "name": "CONVENTION COLLECTIVE NATIONALE - PHARMACIE D'OFFICINE",
              "_links": {
                "self": {
                  "href": "/v1/collective-foresight/agreements/68897"
                }
              }
            },
            {
              "id": 82598,
              "name": "CONVENTION COLLECTIVE NATIONALE - PHARMACIE D'OFFICINE",
              "_links": {
                "self": {
                  "href": "/v1/collective-foresight/agreements/82598"
                }
              }
            }
          ]
        }
      },
      ...
    }
  }
}