ScannerVision Web Server

PostConnections

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

namespace ScannerVision.WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PostConnections() = 
        member val LoginCommand:String = null with get,set
        member val LogoutCommand:String = null with get,set
        member val Password:String = null with get,set
        member val SaveCommand:String = null with get,set
        member val UserName:String = null with get,set

    type PermissionType =
        | Group = 0
        | User = 1

    [<AllowNullLiteral>]
    type IConnectionPermission = 
        abstract Allow:Boolean with get,set
        abstract Connection:IConnectorConnection with get,set
        abstract Type:PermissionType with get,set

    type PropertyType =
        | Binary = 1
        | Boolean = 2
        | ConnectionString = 3
        | Credential = 4
        | Integer = 5
        | Picklist = 6
        | String = 7
        | OAuth2 = 8
        | Certificate = 9

    [<AllowNullLiteral>]
    type IConnectionPropertyDescription = 
        abstract Description:String with get,set
        abstract Name:String with get,set
        abstract PropertyId:Guid with get,set
        abstract PropertyType:PropertyType with get,set

    [<AllowNullLiteral>]
    type IUserGroup = 
        abstract Users:ReadOnlyCollection<IUser> with get,set

    [<AllowNullLiteral>]
    type IUser = 
        abstract Groups:ReadOnlyCollection<IUserGroup> with get,set
        abstract EmailAddress:String with get,set
        abstract HasPassword:Boolean with get,set
        abstract HomeFolder:String with get,set
        abstract Password:String with get,set
        abstract SbcUser:Nullable<Boolean> with get,set

    [<AllowNullLiteral>]
    type IConnectorConnection = 
        abstract ConnectorId:Guid with get,set
        abstract Description:String with get,set
        abstract Id:String with get,set
        abstract MaxConnections:Int32 with get,set
        abstract Name:String with get,set
        abstract Permissions:ReadOnlyCollection<IConnectionPermission> with get,set
        abstract PropertyDescriptions:ReadOnlyCollection<IConnectionPropertyDescription> with get,set
        abstract SetupUser:IUser with get,set

    [<AllowNullLiteral>]
    type GetConnectionsResponse() = 
        member val Connections:IEnumerable<IConnectorConnection> = null with get,set
        member val IsAuthenticated:Boolean = new Boolean() with get,set

F# 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.