API v2.0

This document describes the v2 API of Currinda. This API is focused on the accessing of resources pertaining to associations/organisations within the Currinda database.Please note that parts of this are currently under development and can not be considered stable. Stable endpoints will be marked as such.

API Access

API Access is controlled by each Currinda site. Each client will provide OAuth Client ID and Client Secret information.

URLs

All URLs in this document are based on the root domain of the site. This is usually in the format https://{currinda_site}.currinda.com/

Authentication

Authentication to the API is handled with OAuth2. The majority of endpoints are accessible with the client credentials grant type. Some documentation is provided here.There is also the availability of the OAuth2 authorization code grant type. This allows for the possibility of single sign-on. Here are some guidelines for single sign-on integration.

Token

GET /api/v2/organisation/{organisation_id}/token

This is the token endpoint. Requests to this with a valid client id and secret will return the necessary authorization code.

$ curl -u TestClient:TestSecret https://acme.currinda.com/api/v2/organisation/100/token -d 'grant_type=client_credentials&scope=members' {"access_token":"03807cb390319329bdf6c777d4dfae9c0d3b3c35","expires_in":3600,"token_type":"bearer","scope":null}

This access token should then be used in the Authorization header for any further requests:

curl -H "Authorization: Bearer 03807cb390319329bdf6c777d4dfae9c0d3b3c35" https://acme.currinda.com/api/v2/organisation/100/members

Authorize

GET /api/v2/organisation/{organisation_id}/authorize

Authorization Codes are retrieved using the Authorize Controller. The client must send the user to the OAuth server’s authorize URL.First, redirect the user to the following URL:

https://{currinda_site}/api/v2/organisation/{organisation_id}/authorize?response_type=code&client_id=TestClient&redirect_uri=https://myredirecturi.com/cb

A successful authorization will pass the client the authorization code in the URL via the supplied redirect_uri:

https://myredirecturi.com/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz

Once this is done, a token can be requested using the authorization code.

$ curl -u TestClient:TestSecret https://api.mysite.com/token -d 'grant_type=authorization_code&code=xyz'

A successful token request will return a standard access token in JSON format:

{"access_token":"03807cb390319329bdf6c777d4dfae9c0d3b3c35","expires_in":3600,"token_type":"bearer","scope":null}

Resources

Logged in user information

This is to be used with the authorization code grant type as described above.

GET /api/v2/organisation/{organisation_id}/user

Scope Required

user

Response

{"FirstName":"Peter","LastName":"Test1","Title":"","Email":"test1@example.com","Organisation":"Test Org","Address": {"Address":null,"Suburb":"Test Park","Postcode":"","State":"VIC","Country":"Australia",},"MailingAddress": {"Address":"whatever St","Suburb":"Test Park","Postcode":"","State":"VIC","Country":"Australia",},"Phone":"22423423423","WorkPhone":"23423423423","Mobile":"","Membership": {"ID":"31807","MembershipNumber": "D23423423","ExpiryDate":"2010-12-31","JoiningDate":"2014-05-12","Status":"outstanding","Chapter":null,"MembershipType": {"ID":"362","Type":"Membership Type #1","Cost":"100","Description":"","Student": 0,"Extras": [{"ID":"98","Question":"Test question?","Answer":"Yes 1"}]},"AmountOutstanding":"100.000","Addons":[],"Extras":[]"Currency":"NZD","InvoiceURL":"http:\/\/test.asnevents.localhost\/organisations\/invoice","PaymentURL":"http:\/\/test.asnevents.localhost\/organisations\/payment",},"CorporateMemberships": [{"ID":"60000","MembershipName": "Currinda Software","MembershipNumber": "D2342688","ExpiryDate":"2010-12-31","JoiningDate":"2014-05-12","Status":"outstanding","Chapter":null,"MembershipType": {"ID":"362","Type":"Membership Type #1","Cost":"100","Description":"","Student": 0,"Extras": [{"ID":"98","Question":"Test question?","Answer":"Yes 1"}]},"AmountOutstanding":"100.000","Addons":[],"Extras":[]"Currency":"NZD","InvoiceURL":"http:\/\/test.asnevents.localhost\/organisations\/invoice","PaymentURL":"http:\/\/test.asnevents.localhost\/organisations\/payment",}],"CommitteeMemberships": {"Chapter": null,"Financial": true}}

List memberships in Organisation Stable

GET /api/v2/organisation/{organisation_id}/members

Scope Required

members

GET Parameters

Name	Type	Description
MembershipCategory[]	array	Filter by Membership Category. Find all Memberships with any categories in the specified array
MembershipType[]	array	Filter by MembershipType. Find all Membership with any types in the specifed array.
OrganisationChapter[]	array	Filter by OrganisationChapter. Find all memberships in specified chapters.
FinancialStatus[]	array (default:financial)	Filter by FinancialStatus. [financial,expired,expiring,outstanding]
ExpiryDate[To]	datetime	Filter by memberships with an ExpiryDate before specified.
ExpiryDate[From]	datetime	Filter by memberships with an ExpiryDate after specified.
CurrentAddons[]	array	Find those memberships who have up to date addons in the specified array
ExtraAnswer[]	array	Find those memberships which have selected an extra, the keys of the array are the IDs of the extras, the contents of the array are the answers. (e.g. ExtraAnswer[23][]=Banana&ExtraAnswer[23][]=Lemon)
Searchable	boolean	Filters by memberships that are intended to be searchable. (Current searchable addons and membership types)
Locations	boolean	Filters by memberships that have locations.
User[FirstName]	array,string	Filter by User's First Name.
User[LastName]	array,string	Filter by User's Last Name
User[State]	array	Filter by User's state. Supply any number of states
User[Country]	string	Filter by User's country
User[Organisation]	string	Filter by User's organisation
DateModified[After]	date	Find all memberships that are modified after the provided date. Date should be supplied in ISO 8601 format, however other time formats will be accepted
DateModified[Before]	date	Find all memberships that are modified before the provided date. Date should be supplied in ISO 8601 format.

Response

[{"ID":"31807","MembershipNumber": "D23423423","ExpiryDate":"2010-12-31","JoiningDate":"2014-05-12","Status":"outstanding","Chapter":null,"MembershipType": {"ID":"362","Type":"Membership Type #1","Cost":"100","Description":"","Student": 0,"Extras": [{"ID":"98","Question":"Test question?","Answer":"Yes 1"}]},"AmountOutstanding":"100.000","Addons":[],"Extras":[],"User": {"FirstName":"Peter","LastName":"Test1","Title":"","Email":"test1@example.com","Organisation":"Test Org","Address": {"Address":null,"Suburb":"Test Park","Postcode":"","State":"VIC","Country":"Australia",},"MailingAddress": {"Address":"whatever St","Suburb":"Test Park","Postcode":"","State":"VIC","Country":"Australia",},"Phone":"22423423423","WorkPhone":"23423423423","Mobile":"",},"Currency":"NZD","InvoiceURL":"http:\/\/test.asnevents.localhost\/organisations\/invoice","PaymentURL":"http:\/\/test.asnevents.localhost\/organisations\/payment"}

List membership categories in Organisation Stable

GET /api/v2/organisation/{organisation_id}/categories

Scope Required

basic

Response

[{"ID": 3,"Name":"General Member","Description": "This is a general member category"}]

List membership types in Organisation Stable

GET /api/v2/organisation/{organisation_id}/membershiptypes

Scope Required

basic

GET Parameters

Name	Type	Description
Visible	boolean (default: true)	Filters by membership types that are publicy visible.
Searchable	boolean	Filters by membership types are intended to be searchable.

Response

[{"ID": 3,"Name":"Full Member","Cost":"500.00","Searchable":false,"Visible": false,"AnniversaryExpiry": false,"GST": true}]

List addons in Organisation Stable

GET /api/v2/organisation/{organisation_id}/addons

Scope Required

basic

GET Parameters

Name	Type	Description
Visible	boolean (default: true)	Filters by addons that are publicy visible.
Searchable	boolean	Filters by addons are intended to be searchable.

Response

[{"ID": 3,"Name":"Journal Subscription","Cost":"50.00","Searchable":false,"Visible": false,"GST": true}]

List extras in Organisation Stable

GET /api/v2/organisation/{organisation_id}/extras

Scope Required

basic

GET Parameters

Name	Type	Description
Searchable	boolean	Filters by extras that are intended to be searchable.

Response

[{"ID": 3,"Question":"Do you like things?","Searchable": true,"SearchName": "Things that are liked","AdminOnly": true,"AnswerType": 5,"Options": ["Bananas", "Oranges", "Lemons"]}]

Search locations of an Organisation Beta

GET /api/v2/organisation/{organisation_id}/locations

Scope Required

members

GET Parameters

Name	Type	Description
Geolocation[Lat],Geolocation[Lng], Geolocation[Distance] (default: 50)	float	Search in relation to the latitude longitude of a point. Alternatively add distance in km to filter further
Name	string	Filter by the name of the location
State	string	Filter by the state the location is in

** All parameters available on the members endpoint are also available **

Response

[{"ID":"1022","Email":"test@example.com","Name":"Membership Location #1","Address":"123 Example St.","Suburb":"Test","State":"QLD","Country":"Test","Postcode":"1111","FullPhone":"+123 45678","Website":"http:\/\/www.example.com","Geolocation":{"Lat":"100","Lng":"-42"},"Membership": {"ID":"31807","MembershipNumber": "D23423423","ExpiryDate":"2010-12-31","JoiningDate":"2014-05-12","Status":"outstanding","Chapter":null,"MembershipType": {"ID":"362","Type":"Membership Type #1","Cost":"100","Description":"","Student": 0,"Extras": [{"ID":"98","Question":"Test question?","Answer":"Yes 1"}]},"AmountOutstanding":"100.000","Addons":[],"Extras":[],"User": {"FirstName":"Peter","LastName":"Test1","Title":"","Email":"test1@example.com","Organisation":"Test Org","Address": {"Address":null,"Suburb":"Test Park","Postcode":"","State":"VIC","Country":"Australia",},"MailingAddress": {"Address":"whatever St","Suburb":"Test Park","Postcode":"","State":"VIC","Country":"Australia",},"Phone":"22423423423","WorkPhone":"23423423423","Mobile":"",},"Currency":"NZD","InvoiceURL":"http:\/\/test.asnevents.localhost\/organisations\/invoice","PaymentURL":"http:\/\/test.asnevents.localhost\/organisations\/payment"},"Distance":"0.00005905330181121826"},...]