Joind.in API

The Joind.in API is XML based and allows for the fetching and updating of information in the service's database. Here's an example structure each request should follow:

Sample Request

<request>
        <auth>
                <user>$username</user>
                <pass>$password</pass>
        </auth>
        <action type="getdetail">
                <event_id>1</event_id>
        </action>
</request>

or, if you reprefer JSON:

{"request":{
	"auth":{
		"user":"your_username","pass":"your_password"
	},
	"action":{
		"type":"status",
		"data":{"test_string":"my test"}
	}
}}

In our above examples, you can see the "auth" section where you would replace $username and $password with your login information - the auth section only needs to be included where authentication is required for that action. The password in the auth section should be md5. Below that there's the "action" section which indicates which operation the system should perform. In this example we're making a "getdetail" call to grab the information for the given event ID.

Types

There are four different URLs you can make requests to:

api/site - to get the current status of the web service
api/event - to get information on events
api/talk - to get information on talks
api/user - to get information on users
api/comment - to get information about individual comments

Our sample XML above would need to be sent to "http://joind.in/api/event" to work correctly. If you send it to an incorrect URL you probably won't get quite what you're expecting.

Responses

By default, responses will be made in an JSON format. There is an optional attribute you can add to the "action" tag in your request called "output". This is set to "json" initially but it can also be set to "xml" if you prefer your response in that format. Here's an example of the XML output:

<response>
	<item>
		<talk_title>My Test Talk</talk_title>
		<talk_desc>This is a sample talk description</talk_desc>
		<ID>42</ID>
	</item>
</response>

If there are any errors in the request or problems processing it, an "errors" array will be returned containing the message(s) about where the issue lies.

Request Types

Below are the request types that you can make to the API including input and output variables.

Request Types:

Events
Talks
Comment
- Get Comment Detail
- Mark as Spam
User
Site
- Status

Events (/api/event)

Get Event Detail

Action Type: getdetail
Description: Get the details for a given event number
Authentication: not required
Input:

event_id: integer

Output: An array containing a single object. The object has the following properties:

event_name: string, Name of the event
event_start: Unix timestamp
event_end: Unix timestamp
event_lat: number, Latitude of the venue location
event_long: number, Longitude of the venue location
ID: integer, ID for the event
event_loc: string, Event location
event_desc: string, Event description
active: integer, Whether the event is active or not
event_stub: string, Stub/shortcut value for event
event_icon: string, path to image icon
pending: integer, whether the event is awaiting approval
event_hashtag: string, twitter/blogging hashtag for this event
event_href: string, event homepage
event_cfp_start: unix timestamp, date the call for papers opens for this event
event_cfp_end: unix timestamp, date the call for papers closes for this event
event_voting: integer, whether users can vote on the sessions (currently not in use)
private: integer, whether this event is only visible to its members
event_tz_cont: string, Continent part of timezone name (e.g. 'Europe')
event_tz_place: string, Detial part of timezone name (e.g. 'London')
allow_comments: integer, Whether comments are accepted on this talk (1 for yes, 0 for no)
num_attend: integer, number of people marked as attending
num_comments: integer, the number of comments on this event
user_attending: integer, whether the current user is attending this event
now: string, either "now" if the event is now on or "" if it isn't (not present in event/getlist)
tracks: array, List of track objects associated with this session. Track properties are track_name, ID, track_color used (1 or 0, whether there are sessions in it or not), event_id and track_desc (description) (not present in event/getlist)

Joind.in API

Sample Request

Types

Responses

Request Types

Events (/api/event)

Talks (/api/talk)

Comments (/api/comments)

User (/api/user)

Site (/api/site)

Sign in

Submit your event