ScannerVision Web Server

<back to all web services

JsonRegisterClientRequest

Requires Authentication
"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 .csv suffix or ?format=csv

HTTP + CSV

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

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

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

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