ScannerVision Web Server

JsonRegisterClientRequest


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 .xml suffix or ?format=xml

HTTP + XML

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

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

<JsonRegisterClientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ClientCode>String</ClientCode>
  <ClientRegistrationCode>String</ClientRegistrationCode>
  <Token>String</Token>
</JsonRegisterClientRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JsonRegisterClientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ClientRegistrationCode>String</ClientRegistrationCode>
  <ErrorMessage>String</ErrorMessage>
  <Result>Success</Result>
</JsonRegisterClientResponse>