Geniuslink.MarkableApi

<back to all web services

Hello

The following routes are available for this service:
All Verbs/hello
All Verbs/hello/{Name}

// @DataContract
export class BaseResponse
{
    // @DataMember(Name="responseStatus")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class HelloResponseData
{
    public greeting: string;

    public constructor(init?: Partial<HelloResponseData>) { (Object as any).assign(this, init); }
}

export class HelloResponse extends BaseResponse
{
    public data: HelloResponseData;

    public constructor(init?: Partial<HelloResponse>) { super(init); (Object as any).assign(this, init); }
}

export class Hello implements IHasVersion
{
    public name: string;
    public version: number;

    public constructor(init?: Partial<Hello>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}