Skip to content

Communication protocol

Eragon666 edited this page Jun 25, 2015 · 10 revisions
{
	"info": [
		{
			"id": "Connection ID/key",
			"corpusSet": "NOS",
			"type": "click/realtime"
		}
	],
	"overall": [
		{
			"aviScore": "45",
			"ciltScore": "10",
			"clibScore": "15",
			"analytics": {
				"totalWords": "10455",
				"paragraphs": "2",
				"averageSentence": "10",
			}
		}	
	],
	"corpus:" [
		{
			"avgLetters": "10",
			"freqCommonWords": "666",
			"typeTokenFrequency": "44",
			"avgWords": "12",
			"aviScore": "10",
			"clibScore": "100",
			"ciltScore": "1000"
		}
	],
	"text": [
		{
			"paragraph": "Lorem ipsum dolor sit amet",
			"paragraphColour": "#123456",
			"aviScore": "40",
			"analytics": {
				"totalWords": "5000",
				"averageSentence": "8"
			},
			"highlights": [
				{
					"text": "Searchword",
					"color": "0 t/m 5",
					"front": "word in front",
					"behind": "word after",
					"hint": "hint to display"
				}				
			],
			"checks": [
				"wordHighlights": "false",
				"sentenceHighlights": "false",
				"freqCommonWordsHighlights": "false",
				"typeTokenFrequencyHighlights": "false"
			],
			"changed": "TRUE"
		},
		{
			"paragraph": "Tweede lorem ipsum paragraaf",
			"paragraphColour": "#123456",
			"aviScore": "50",
			"analytics": {
				"totalWords": "5455",
				"averageSentence": "12"
			},
			"changed": "FALSE"
		}
	]
}

The communication protocol is written in JSON. At this moment it consists of three main objects:

  • info: basic info for authentication
  • overall: overall analysis for the text
  • corpus: overall analysis for the complete corpus
  • text: content per paragraph and analysis for each paragraph