ScannerVision Web Server

<back to all web services

GetConnections

The following routes are available for this service:
GET/connections
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ScannerVision.WebService.ServiceModel;
using ScannerVision.Settings.Interfaces;
using ScannerVision.Settings;
using ScannerVision.Types.Connections;

namespace ScannerVision.Settings
{
    public enum PermissionType
    {
        Group,
        User,
    }

}

namespace ScannerVision.Settings.Interfaces
{
    public partial interface IConnectionPermission
        : IInterface
    {
        bool Allow { get; set; }
        IConnectorConnection Connection { get; set; }
        PermissionType Type { get; set; }
    }

    public partial interface IConnectionPropertyDescription
        : IInterface
    {
        string Description { get; set; }
        string Name { get; set; }
        Guid PropertyId { get; set; }
        PropertyType PropertyType { get; set; }
    }

    public partial interface IConnectorConnection
        : IStatus
    {
        Guid ConnectorId { get; set; }
        string Description { get; set; }
        string Id { get; set; }
        int MaxConnections { get; set; }
        string Name { get; set; }
        ReadOnlyCollection<IConnectionPermission> Permissions { get; set; }
        ReadOnlyCollection<IConnectionPropertyDescription> PropertyDescriptions { get; set; }
        IUser SetupUser { get; set; }
    }

    public partial interface IUser
        : IIdTemplatesItem
    {
        ReadOnlyCollection<IUserGroup> Groups { get; set; }
        string EmailAddress { get; set; }
        bool HasPassword { get; set; }
        string HomeFolder { get; set; }
        string Password { get; set; }
        bool? SbcUser { get; set; }
    }

    public partial interface IUserGroup
        : IIdTemplatesItem, IGroup
    {
        ReadOnlyCollection<IUser> Users { get; set; }
    }

}

namespace ScannerVision.Types.Connections
{
    public enum PropertyType
    {
        Binary = 1,
        Boolean = 2,
        ConnectionString = 3,
        Credential = 4,
        Integer = 5,
        Picklist = 6,
        String = 7,
        OAuth2 = 8,
        Certificate = 9,
    }

}

namespace ScannerVision.WebService.ServiceModel
{
    public partial class GetConnections
    {
    }

    public partial class GetConnectionsResponse
    {
        public virtual IEnumerable<IConnectorConnection> Connections { get; set; }
        public virtual bool IsAuthenticated { get; set; }
    }

}

C# GetConnections 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.

GET /connections HTTP/1.1 
Host: buildmax.org 
Accept: text/jsonl
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.