ScannerVision Web Server

<back to all web services

JsonRegisterClientRequest

Requires Authentication

export class JsonDto
{

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

export class JsonRequestDto extends JsonDto
{
    public ClientCode: string;
    public ClientRegistrationCode: string;
    public Token: string;

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

export class JsonRegisterClientRequest extends JsonRequestDto
{

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

export enum RegistrationResult
{
    Success = 'Success',
    ClientCodeNotFound = 'ClientCodeNotFound',
    ClientAlreadyRegistered = 'ClientAlreadyRegistered',
    Error = 'Error',
}

export class JsonRegisterClientResponse extends JsonDto
{
    public Result: RegistrationResult;
    public ErrorMessage: string;
    public ClientRegistrationCode: string;

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

TypeScript JsonRegisterClientRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/JsonRegisterClientRequest HTTP/1.1 
Host: buildmax.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ClientCode":"String","ClientRegistrationCode":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Result":"Success","ErrorMessage":"String","ClientRegistrationCode":"String"}