ScannerVision Web Server

PostConnections

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


export class PostConnections
{
    public LoginCommand: string;
    public LogoutCommand: string;
    public Password: string;
    public SaveCommand: string;
    public UserName: string;

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

export enum PermissionType
{
    Group = 'Group',
    User = 'User',
}

export interface IConnectionPermission extends IInterface
{
    Allow: boolean;
    Connection: IConnectorConnection;
    Type: PermissionType;
}

export enum PropertyType
{
    Binary = 1,
    Boolean = 2,
    ConnectionString = 3,
    Credential = 4,
    Integer = 5,
    Picklist = 6,
    String = 7,
    OAuth2 = 8,
    Certificate = 9,
}

export interface IConnectionPropertyDescription extends IInterface
{
    Description: string;
    Name: string;
    PropertyId: string;
    PropertyType: PropertyType;
}

export interface IUserGroup extends IIdTemplatesItem, IGroup
{
    Users: ReadOnlyCollection<IUser>;
}

export interface IUser extends IIdTemplatesItem
{
    Groups: ReadOnlyCollection<IUserGroup>;
    EmailAddress: string;
    HasPassword: boolean;
    HomeFolder: string;
    Password: string;
    SbcUser?: boolean;
}

export interface IConnectorConnection extends IStatus
{
    ConnectorId: string;
    Description: string;
    Id: string;
    MaxConnections: number;
    Name: string;
    Permissions: ReadOnlyCollection<IConnectionPermission>;
    PropertyDescriptions: ReadOnlyCollection<IConnectionPropertyDescription>;
    SetupUser: IUser;
}

export class GetConnectionsResponse
{
    public Connections: IConnectorConnection[];
    public IsAuthenticated: boolean;

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

TypeScript PostConnections DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'GetConnectionsResponse' using the custom 'other' filter}No parameterless constructor defined for this object.