Geniuslink.MarkableApi

<back to all web services

Hello

The following routes are available for this service:
All Verbs/hello
All Verbs/hello/{Name}
"use strict";
export class BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
}
export class HelloResponseData {
    /** @param {{greeting?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    greeting;
}
export class HelloResponse extends BaseResponse {
    /** @param {{data?:HelloResponseData,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {HelloResponseData} */
    data;
}
export class Hello {
    /** @param {{name?:string,version?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    name;
    /** @type {number} */
    version;
}

JavaScript Hello DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /hello HTTP/1.1 
Host: geniuslink-markable-api.qa.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	name: String,
	version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		greeting: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}