Skip to content

AnnuaireApi.md

Latest commit

 

History

History
120 lines (82 loc) · 6.67 KB

AnnuaireApi.md

File metadata and controls

120 lines (82 loc) · 6.67 KB

HelloAssoApi.AnnuaireApi

All URIs are relative to https://api.helloasso.com/v5

Method HTTP request Description
directoryFormsPost POST /directory/forms Récupérer les formulaires
directoryOrganizationsPost POST /directory/organizations Récupérer les organisations

directoryFormsPost

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelSynchronizableFormModel directoryFormsPost(opts)

Récupérer les formulaires

Permet de récupérer une liste de tous les formulaires visibles correspondant à tous les filtres de l'annuaire jusqu'à ce qu'il soit synchronisé (en utilisant le continuationToken). Si aucun filtre n'est spécifié, aucun filtre n'est appliqué. Les résultats sont classés par date de mise à jour de la visibilité API en ordre croissant. Une fois la liste synchronisée, seuls les formulaires avec une date de mise à jour de la visibilité API supérieure à la dernière forme envoyée sont retournés (toujours en utilisant le continuationToken). Cela concerne les nouveaux formulaires à insérer (souhaitant apparaître de l'annuaire) ainsi que les anciens à supprimer (ne souhaitant plus apparaître dans l'annuaire). Le nombre total de résultats (ou de pages) n'est pas récupérable, donc les informations de pagination retournées indiqueront toujours -1.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> FormOpenDirectory<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.AnnuaireApi();
let opts = {
  'pageSize': 20, // Number | The number of items per page
  'continuationToken': "continuationToken_example", // String | Continuation Token from which we wish to retrieve results
  'helloAssoApiV5CommonModelsDirectoryListFormsRequest': new HelloAssoApi.HelloAssoApiV5CommonModelsDirectoryListFormsRequest() // HelloAssoApiV5CommonModelsDirectoryListFormsRequest | Body which contains the filters to apply
};
apiInstance.directoryFormsPost(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pageSize Number The number of items per page [optional] [default to 20]
continuationToken String Continuation Token from which we wish to retrieve results [optional]
helloAssoApiV5CommonModelsDirectoryListFormsRequest HelloAssoApiV5CommonModelsDirectoryListFormsRequest Body which contains the filters to apply [optional]

Return type

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelSynchronizableFormModel

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

directoryOrganizationsPost

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelSynchronizableOrganizationModel directoryOrganizationsPost(opts)

Récupérer les organisations

Permet de récupérer une liste de toutes les organisations visibles correspondant à tous les filtres de l'annuaire jusqu'à ce qu'il soit synchronisé (en utilisant le continuationToken). Si aucun filtre n'est spécifié, aucun filtre n'est appliqué. Les résultats sont classés par date de mise à jour de la visibilité API en ordre croissant. Une fois la liste synchronisée, seules les organisations avec une date de mise à jour de la visibilité API supérieure à la dernière organisation envoyée sont retournées (toujours en utilisant le continuationToken). Cela concerne les nouvelles organisations à insérer (souhaitant apparaître dans l'annuaire) ainsi que les anciennes à supprimer (ne souhaitant plus apparaître dans l'annuaire). Le nombre total de résultats (ou de pages) n'est pas récupérable, donc les informations de pagination retournées indiqueront toujours -1.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> OrganizationOpenDirectory<br/><br/>

Example

import HelloAssoApi from 'hello_asso_api';
let defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
let OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new HelloAssoApi.AnnuaireApi();
let opts = {
  'pageSize': 20, // Number | The number of items per page
  'continuationToken': "continuationToken_example", // String | Continuation Token from which we wish to retrieve results
  'helloAssoApiV5CommonModelsDirectoryListOrganizationsRequest': new HelloAssoApi.HelloAssoApiV5CommonModelsDirectoryListOrganizationsRequest() // HelloAssoApiV5CommonModelsDirectoryListOrganizationsRequest | Body which contains the filters to apply
};
apiInstance.directoryOrganizationsPost(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pageSize Number The number of items per page [optional] [default to 20]
continuationToken String Continuation Token from which we wish to retrieve results [optional]
helloAssoApiV5CommonModelsDirectoryListOrganizationsRequest HelloAssoApiV5CommonModelsDirectoryListOrganizationsRequest Body which contains the filters to apply [optional]

Return type

HelloAssoApiV5CommonModelsCommonResultsWithPaginationModelSynchronizableOrganizationModel

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json