ScannerVision Web Server

PostConnections

The following routes are available for this service:
POST	/connections

"use strict";
export class PostConnections {
    /** @param {{LoginCommand?:string,LogoutCommand?:string,Password?:string,SaveCommand?:string,UserName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LoginCommand;
    /** @type {string} */
    LogoutCommand;
    /** @type {string} */
    Password;
    /** @type {string} */
    SaveCommand;
    /** @type {string} */
    UserName;
}
/** @typedef {'Group'|'User'} */
export var PermissionType;
(function (PermissionType) {
    PermissionType["Group"] = "Group"
    PermissionType["User"] = "User"
})(PermissionType || (PermissionType = {}));
/** @typedef {number} */
export var PropertyType;
(function (PropertyType) {
    PropertyType[PropertyType["Binary"] = 1] = "Binary"
    PropertyType[PropertyType["Boolean"] = 2] = "Boolean"
    PropertyType[PropertyType["ConnectionString"] = 3] = "ConnectionString"
    PropertyType[PropertyType["Credential"] = 4] = "Credential"
    PropertyType[PropertyType["Integer"] = 5] = "Integer"
    PropertyType[PropertyType["Picklist"] = 6] = "Picklist"
    PropertyType[PropertyType["String"] = 7] = "String"
    PropertyType[PropertyType["OAuth2"] = 8] = "OAuth2"
    PropertyType[PropertyType["Certificate"] = 9] = "Certificate"
})(PropertyType || (PropertyType = {}));
export class GetConnectionsResponse {
    /** @param {{Connections?:IConnectorConnection[],IsAuthenticated?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {IConnectorConnection[]} */
    Connections;
    /** @type {boolean} */
    IsAuthenticated;
}

JavaScript PostConnections 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 /connections HTTP/1.1 
Host: buildmax.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"LoginCommand":"String","LogoutCommand":"String","Password":"String","SaveCommand":"String","UserName":"String"}

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

{"IsAuthenticated":false}