Skip to content

Latest commit

 

History

History
206 lines (133 loc) · 7.94 KB

OrganisationApi.md

File metadata and controls

206 lines (133 loc) · 7.94 KB

HelloAssoApi.OrganisationApi

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

Method HTTP request Description
organizationsLegalInformationsLegalStructuresGet GET /organizations/legal-informations/legal-structures Obtenir la structure juridique d'une organisation visible.
organizationsLegalInformationsOrganizationSlugConfigurationGet GET /organizations/legal-informations/{organizationSlug}/configuration
organizationsLegalInformationsTaxInformationTextsGet GET /organizations/legal-informations/tax-information-texts
organizationsOrganizationSlugGet GET /organizations/{organizationSlug} Obtenir le détail d'une organisation

organizationsLegalInformationsLegalStructuresGet

[HelloAssoApiV5ModelsOrganizationLegalInformationsOrganizationLegalStructuresModel] organizationsLegalInformationsLegalStructuresGet()

Obtenir la structure juridique d'une organisation visible.

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>OrganizationAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> OrganizationAdministration<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.OrganisationApi();
apiInstance.organizationsLegalInformationsLegalStructuresGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

[HelloAssoApiV5ModelsOrganizationLegalInformationsOrganizationLegalStructuresModel]

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

organizationsLegalInformationsOrganizationSlugConfigurationGet

HelloAssoModelsAccountsOrganizationLegalInformationsOrganizationLegalInformationConfiguration organizationsLegalInformationsOrganizationSlugConfigurationGet(organizationSlug)

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>OrganizationAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> OrganizationAdministration<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.OrganisationApi();
let organizationSlug = "organizationSlug_example"; // String | 
apiInstance.organizationsLegalInformationsOrganizationSlugConfigurationGet(organizationSlug, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationSlug String

Return type

HelloAssoModelsAccountsOrganizationLegalInformationsOrganizationLegalInformationConfiguration

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

organizationsLegalInformationsTaxInformationTextsGet

[HelloAssoModelsAccountsOrganizationLegalInformationsTaxInformationText] organizationsLegalInformationsTaxInformationTextsGet(opts)

<br/><br/><b>Votre token doit avoir l'un de ces rôles : </b><br/>OrganizationAdmin<br/><br/>Si vous êtes une <b>association</b>, vous pouvez obtenir ces rôles avec votre client.<br/>Si vous êtes un <b>partenaire</b>, vous pouvez obtenir ces rôles par le flux d'autorisation.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> OrganizationAdministration<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.OrganisationApi();
let opts = {
  'organizationSlug': "organizationSlug_example" // String | 
};
apiInstance.organizationsLegalInformationsTaxInformationTextsGet(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationSlug String [optional]

Return type

[HelloAssoModelsAccountsOrganizationLegalInformationsTaxInformationText]

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

organizationsOrganizationSlugGet

HelloAssoApiV5ModelsOrganizationOrganizationModel organizationsOrganizationSlugGet(organizationSlug)

Obtenir le détail d'une organisation

Obtenir les informations publiques de l'organisation spécifiée.<br/><br/><b>Votre clientId doit être autorisé à tous ces privilèges : </b> <br/> AccessPublicData<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.OrganisationApi();
let organizationSlug = "organizationSlug_example"; // String | The organization Slug
apiInstance.organizationsOrganizationSlugGet(organizationSlug, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationSlug String The organization Slug

Return type

HelloAssoApiV5ModelsOrganizationOrganizationModel

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json