Skip to content

Latest commit

 

History

History
234 lines (162 loc) · 12 KB

FormulairesApi.md

File metadata and controls

234 lines (162 loc) · 12 KB

HelloAssoApi.FormulairesApi

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

Method HTTP request Description
organizationsOrganizationSlugFormTypesGet GET /organizations/{organizationSlug}/formTypes Obtenir une liste des types de formulaires pour une organisation
organizationsOrganizationSlugFormsFormTypeActionQuickCreatePost POST /organizations/{organizationSlug}/forms/{formType}/action/quick-create Créer un événement simplifié pour un organisme
organizationsOrganizationSlugFormsFormTypeFormSlugPublicGet GET /organizations/{organizationSlug}/forms/{formType}/{formSlug}/public Obtenir des données publiques détaillées sur un formulaire
organizationsOrganizationSlugFormsGet GET /organizations/{organizationSlug}/forms Obtenir les formulaires d'une organisation

organizationsOrganizationSlugFormTypesGet

[HelloAssoApiV5ModelsEnumsFormType] organizationsOrganizationSlugFormTypesGet(organizationSlug, opts)

Obtenir une liste des types de formulaires pour une organisation

Liste tous les types de formulaires où l'organisation possède au moins un formulaire. Cela peut également être filtré par états.<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.FormulairesApi();
let organizationSlug = "organizationSlug_example"; // String | The organization Slug
let opts = {
  'states': [new HelloAssoApi.HelloAssoApiV5ModelsEnumsFormState()] // [HelloAssoApiV5ModelsEnumsFormState] | List of Form States to filter with. If none specified, it won't filter results.  Available values: * `Public` - The form is publicly visible and findable on search engines * `Private` - The form is visible only with the URL, you cannot find it on search engines * `Draft` - The form is not yet published but visible if you have admin rights * `Disabled` - The form is disabled and can be reenabled by changing state to public or private
};
apiInstance.organizationsOrganizationSlugFormTypesGet(organizationSlug, 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 The organization Slug
states [HelloAssoApiV5ModelsEnumsFormState] List of Form States to filter with. If none specified, it won't filter results. Available values: * `Public` - The form is publicly visible and findable on search engines * `Private` - The form is visible only with the URL, you cannot find it on search engines * `Draft` - The form is not yet published but visible if you have admin rights * `Disabled` - The form is disabled and can be reenabled by changing state to public or private [optional]

Return type

[HelloAssoApiV5ModelsEnumsFormType]

Authorization

OAuth2

HTTP request headers

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

organizationsOrganizationSlugFormsFormTypeActionQuickCreatePost

HelloAssoApiV5ModelsFormsFormQuickCreateModel organizationsOrganizationSlugFormsFormTypeActionQuickCreatePost(organizationSlug, formType, opts)

Créer un événement simplifié pour un organisme

Permet la création d'un événement avec seulement des informations limitées et quelques tarifications simples. L'événement créé de cette manière peut être modifié ultérieurement avec d'autres services<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/> FormAdministration<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.FormulairesApi();
let organizationSlug = "organizationSlug_example"; // String | The organization Slug
let formType = new HelloAssoApi.HelloAssoApiV5ModelsEnumsFormType(); // HelloAssoApiV5ModelsEnumsFormType | The form type to create - only Event type is supported
let opts = {
  'helloAssoApiV5ModelsFormsFormQuickCreateRequest': new HelloAssoApi.HelloAssoApiV5ModelsFormsFormQuickCreateRequest() // HelloAssoApiV5ModelsFormsFormQuickCreateRequest | The body of the request.
};
apiInstance.organizationsOrganizationSlugFormsFormTypeActionQuickCreatePost(organizationSlug, formType, 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 The organization Slug
formType HelloAssoApiV5ModelsEnumsFormType The form type to create - only Event type is supported
helloAssoApiV5ModelsFormsFormQuickCreateRequest HelloAssoApiV5ModelsFormsFormQuickCreateRequest The body of the request. [optional]

Return type

HelloAssoApiV5ModelsFormsFormQuickCreateModel

Authorization

OAuth2

HTTP request headers

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

organizationsOrganizationSlugFormsFormTypeFormSlugPublicGet

HelloAssoApiV5ModelsFormsFormPublicModel organizationsOrganizationSlugFormsFormTypeFormSlugPublicGet(organizationSlug, formType, formSlug)

Obtenir des données publiques détaillées sur un formulaire

Permet de récupérer toutes les informations publiques d'un formulaire, qu'il s'agisse de Crowdfunding, d'Adhésion, d'Événement, de Don...<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.FormulairesApi();
let organizationSlug = "organizationSlug_example"; // String | 
let formType = new HelloAssoApi.HelloAssoApiV5ModelsEnumsFormType(); // HelloAssoApiV5ModelsEnumsFormType | 
let formSlug = "formSlug_example"; // String | 
apiInstance.organizationsOrganizationSlugFormsFormTypeFormSlugPublicGet(organizationSlug, formType, formSlug, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
organizationSlug String
formType HelloAssoApiV5ModelsEnumsFormType
formSlug String

Return type

HelloAssoApiV5ModelsFormsFormPublicModel

Authorization

OAuth2

HTTP request headers

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

organizationsOrganizationSlugFormsGet

ResultsWithPaginationModelFormLightModel organizationsOrganizationSlugFormsGet(organizationSlug, opts)

Obtenir les formulaires d'une organisation

Liste tous les formulaires correspondant aux états et types. Si aucun filtre n'est spécifié, aucun filtre n'est appliqué. Les résultats sont classés par date de création en ordre décroissant.<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.FormulairesApi();
let organizationSlug = "organizationSlug_example"; // String | The organization Slug
let opts = {
  'states': [new HelloAssoApi.HelloAssoApiV5ModelsEnumsFormState()], // [HelloAssoApiV5ModelsEnumsFormState] | States to filter  Available values: * `Public` - The form is publicly visible and findable on search engines * `Private` - The form is visible only with the URL, you cannot find it on search engines * `Draft` - The form is not yet published but visible if you have admin rights * `Disabled` - The form is disabled and can be reenabled by changing state to public or private
  'formTypes': [new HelloAssoApi.HelloAssoApiV5ModelsEnumsFormType()], // [HelloAssoApiV5ModelsEnumsFormType] | Types to filter
  'pageIndex': 1, // Number | The page of results to retrieve
  'pageSize': 20, // Number | The number of items per page
  'continuationToken': "continuationToken_example" // String | Continuation Token from which we wish to retrieve results
};
apiInstance.organizationsOrganizationSlugFormsGet(organizationSlug, 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 The organization Slug
states [HelloAssoApiV5ModelsEnumsFormState] States to filter Available values: * `Public` - The form is publicly visible and findable on search engines * `Private` - The form is visible only with the URL, you cannot find it on search engines * `Draft` - The form is not yet published but visible if you have admin rights * `Disabled` - The form is disabled and can be reenabled by changing state to public or private [optional]
formTypes [HelloAssoApiV5ModelsEnumsFormType] Types to filter [optional]
pageIndex Number The page of results to retrieve [optional] [default to 1]
pageSize Number The number of items per page [optional] [default to 20]
continuationToken String Continuation Token from which we wish to retrieve results [optional]

Return type

ResultsWithPaginationModelFormLightModel

Authorization

OAuth2

HTTP request headers

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