API Judge.me

Instructions

Judge.me data API allows a program to perform many of the operations offered by judge.me. It is possible to create new cases, list theme and view data. Keeping in touch with judge.me features will be easier due to the instant access provided by web platforms, mobile phones and portable devices.

The data API is for developers who want to integrate judge.me functionalities in a desktop or a web application. This API is built based on the REST (Representational State Transfer) software architecture style. Methods can return data using the XML or JSON data format

How to use Judge.me API?

If you want to create an application using judge.me API, first you need to contact support with your cover letter including why you want to use our API.

Response Status Code

• 200: OK
• 401: Unauthorized. Returned when trying to execute an authenticated method without valid credentials.
• 404: Not Found. No method, or no data found.
• 500: API Error. There was an error when executing a method. The message field contains details of the error.

Example Clients

• Ruby Language

Cases

New Case

Response format JSON

POST http://www.judge.me/api/v1/cases.json

Response format XML

POST http://www.judge.me/api/v1/cases.xml

Parameters

api_key Required	String	Your judge.me API Key
full_payment Optional	Boolean	If full payment is true, the filer pays the entire $299 fee. If not, both parties pay $149.5.

Case

case[summary] Required

String

Your case summary.

Filer

filer[first_name] Required	String	The filer first name.
filer[last_name] Required	String	The filer last name.
filer[email] Required	String	The filer email address. This should be a valid email address format.
filer[business] Optional	Boolean	The filer is a bussiness.
filer[business_name] Optional	String	The filer bussiness name.
filer[buyer] Optional	Boolean	The filer is the buyer, client or customer. If the buyer isn't present, as default the filer is the seller, contractor or service provider.

Responder

responder[first_name] Required	String	The filer first name.
responder[last_name] Required	String	The filer last name.
responder[email] Required	String	The filer email address. This should be a valid email address format.
responder[business] Optional	Boolean	The responder is a bussiness.
responder[business_name] Optional	String	The responder bussiness name.

Response

rsp {
	status: 200,
	case: {
		auth_key: sd3fCxX
	}
}

List Cases

Response format JSON

GET http://www.judge.me/api/v1/cases.json

Response format XML

GET http://www.judge.me/api/v1/cases.xml

Parameters

api_key Required	String	Your judge.me API Key
page Optional	Boolean	By default the page number is 1. Every request returns 100 cases, but they can be paginated.

Response

rsp {
	status: 200,
	cases: 223,
	hearings: 122,
	page: 1,
	pages: 3,
	cases: {
		case: 
		{
			id: 34323,
			filer: Fabían Ramírez
			responder: Peter Jan Celis,
			auth_key: sd3fVxX,
			created_at: 2012-06-20 18:10:37 -0400
		}
	}

}

Show Case

Response format JSON

GET http://www.judge.me/api/v1/cases/{auth_key}.json

Response format XML

GET http://www.judge.me/api/v1/cases/{auth_key}.xml

Parameters

api_key Required

String

Your judge.me API Key

Response

rsp {
	status: 200,
	case: 
	{
		id: 34323,
		summary: "This is an example from the API",
		filer: {
			first_name:  Peter,
			last_name:  Jan,
			bussiness_name: judge.me,
			email: ex@mple.com,
			buyer: true,
			seller: false,
			full_payment: false
		},
		responder: {
			first_name:  Fabian,
			last_name:  Ramirez,
			bussiness_name: acid.cl,
			email: ex@mple.com,
			buyer: true,
			seller: false
		},
		is_started: true,
		created_at:2012-06-20T21:49:05Z
	}

}

Messages

Show Messages

api_key Required

String

Your judge.me API Key

Response format JSON

GET http://www.judge.me/api/v1/cases/{auth_key}/messages.json

Response format XML

GET http://www.judge.me/api/v1/cases/{auth_key}/messages.xml

Response

rsp {
	status: 200,
	messages: 
	{
		message: {
			is_arbitrator:  false,
			is_filer:  true,
			is_responder:  false,
			body: "This is a test",
			attachments: { 
				attachment: {
					created_at: 2012-06-22T18:47:14Z,
					file: { url: http://test.url/attachment.pdf }, 
				} 
			},
			sender: em@ail.com,
			created_at: 2012-06-22T18:47:14Z
		}
	}

}