ScannerVision Web Server

JsonRegisterClientRequest

"use strict";
export class JsonDto {
    constructor(init) { Object.assign(this, init) }
}
export class JsonRequestDto extends JsonDto {
    /** @param {{ClientCode?:string,ClientRegistrationCode?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    ClientCode;
    /** @type {string} */
    ClientRegistrationCode;
    /** @type {string} */
    Token;
}
export class JsonRegisterClientRequest extends JsonRequestDto {
    /** @param {{ClientCode?:string,ClientRegistrationCode?:string,Token?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {'Success'|'ClientCodeNotFound'|'ClientAlreadyRegistered'|'Error'} */
export var RegistrationResult;
(function (RegistrationResult) {
    RegistrationResult["Success"] = "Success"
    RegistrationResult["ClientCodeNotFound"] = "ClientCodeNotFound"
    RegistrationResult["ClientAlreadyRegistered"] = "ClientAlreadyRegistered"
    RegistrationResult["Error"] = "Error"
})(RegistrationResult || (RegistrationResult = {}));
export class JsonRegisterClientResponse extends JsonDto {
    /** @param {{Result?:RegistrationResult,ErrorMessage?:string,ClientRegistrationCode?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {RegistrationResult} */
    Result;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    ClientRegistrationCode;
}

JavaScript 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>