MiscApi.md

CodingAsActivism.MiscApi

All URIs are relative to https://api.securevan.com/v4

Method	HTTP request	Description
echoesPost	POST /echoes	Hello world
events4306Get	GET /events/4306	Get event details
people100879417CanvassResponsesPost	POST /people/100879417/canvassResponses	Collect canvass data
peopleFindOrCreatePost	POST /people/findOrCreate	Create a volunteer record
signupsPost	POST /signups	RSVP to an event

echoesPost

echoesPost(contentType, body)

Hello world

Example

var CodingAsActivism = require('coding_as_activism');
var defaultClient = CodingAsActivism.ApiClient.instance;

// Configure HTTP basic authorization: auth
var auth = defaultClient.authentications['auth'];
auth.username = 'YOUR USERNAME';
auth.password = 'YOUR PASSWORD';

var apiInstance = new CodingAsActivism.MiscApi();

var contentType = "contentType_example"; // String | 

var body = new CodingAsActivism.HelloworldRequest(); // HelloworldRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.echoesPost(contentType, body, callback);

Parameters

Name	Type	Description	Notes
contentType	String
body	HelloworldRequest

Return type

null (empty response body)

Authorization

auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

events4306Get

events4306Get(expand, authorization)

Get event details

Example

var CodingAsActivism = require('coding_as_activism');
var defaultClient = CodingAsActivism.ApiClient.instance;

// Configure HTTP basic authorization: auth
var auth = defaultClient.authentications['auth'];
auth.username = 'YOUR USERNAME';
auth.password = 'YOUR PASSWORD';

var apiInstance = new CodingAsActivism.MiscApi();

var expand = "expand_example"; // String | 

var authorization = "authorization_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.events4306Get(expand, authorization, callback);

Parameters

Name	Type	Description	Notes
expand	String
authorization	String

Return type

null (empty response body)

Authorization

auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

people100879417CanvassResponsesPost

people100879417CanvassResponsesPost(contentType, authorization, body)

Collect canvass data

Example

var CodingAsActivism = require('coding_as_activism');
var defaultClient = CodingAsActivism.ApiClient.instance;

// Configure HTTP basic authorization: auth
var auth = defaultClient.authentications['auth'];
auth.username = 'YOUR USERNAME';
auth.password = 'YOUR PASSWORD';

var apiInstance = new CodingAsActivism.MiscApi();

var contentType = "contentType_example"; // String | 

var authorization = "authorization_example"; // String | 

var body = new CodingAsActivism.CollectcanvassdataRequest(); // CollectcanvassdataRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.people100879417CanvassResponsesPost(contentType, authorization, body, callback);

Parameters

Name	Type	Description	Notes
contentType	String
authorization	String
body	CollectcanvassdataRequest

Return type

null (empty response body)

Authorization

auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

peopleFindOrCreatePost

peopleFindOrCreatePost(contentType, authorization, body)

Create a volunteer record

Example

var CodingAsActivism = require('coding_as_activism');
var defaultClient = CodingAsActivism.ApiClient.instance;

// Configure HTTP basic authorization: auth
var auth = defaultClient.authentications['auth'];
auth.username = 'YOUR USERNAME';
auth.password = 'YOUR PASSWORD';

var apiInstance = new CodingAsActivism.MiscApi();

var contentType = "contentType_example"; // String | 

var authorization = "authorization_example"; // String | 

var body = new CodingAsActivism.CreateavolunteerrecordRequest(); // CreateavolunteerrecordRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.peopleFindOrCreatePost(contentType, authorization, body, callback);

Parameters

Name	Type	Description	Notes
contentType	String
authorization	String
body	CreateavolunteerrecordRequest

Return type

null (empty response body)

Authorization

auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

signupsPost

signupsPost(contentType, authorization, body)

RSVP to an event

Example

var CodingAsActivism = require('coding_as_activism');
var defaultClient = CodingAsActivism.ApiClient.instance;

// Configure HTTP basic authorization: auth
var auth = defaultClient.authentications['auth'];
auth.username = 'YOUR USERNAME';
auth.password = 'YOUR PASSWORD';

var apiInstance = new CodingAsActivism.MiscApi();

var contentType = "contentType_example"; // String | 

var authorization = "authorization_example"; // String | 

var body = new CodingAsActivism.RSVPtoaneventRequest(); // RSVPtoaneventRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.signupsPost(contentType, authorization, body, callback);

Parameters

Name	Type	Description	Notes
contentType	String
authorization	String
body	RSVPtoaneventRequest

Return type

null (empty response body)

Authorization

auth

HTTP request headers

• Content-Type: application/json
• Accept: application/json