note.md

Collint Protocol

Word object

{
	"lang": "langCode",
	"word": "UTF8String",
	"pronunciation": "UTF8String",
	"translations": [
		{
			"lang": "langCode",
			"type": "WordType",
			"translation": "UTF8String"
		}
	],
	"examples": [
		{
			"lang": "langCode",
			"example": "A UTF8String with ~ substituting the word"
		}
	]
}

Registration

{
	"type": "c",
	"data": {
		"mode": "user",
		"name": "UserName",
		"password": "Plain password"
	}
}

{
	"status": 201
}

Login

{
	"type": "r",
	"data": {
		"mode": "user",
		"name": "UserName",
		"password": "Plain password"
	}
}

{
	"status": 200,
	"data": {
		"token": "Token"
	}
}

Create/Update word

{
	"type": "c (u for update)",
	"data": {
		"mode": "word",
		"word": { "WordObject":"..." },
		"token": "Token"
	}
}

{
	"status": 201
}

Query word

{
	"type": "r",
	"data": {
		"mode": "word",
		"query": "UTF8String|RegExp",
		"token": "Token"
	}
}

{
	"status": 200,
	"data": [
		{ "WordObject":"..." }
	]
}

Delete word

{
	"type": "d",
	"data": {
		"mode": "word",
		"query": "WordOID"
	}
}