Field Squared API Services

<back to all web services

ExternalConnection

Used to register connection details for external systems.
Supported ConnectionTypes: 'Database'. Supported DatabaseTypes: 'SqlServer'

The following routes are available for this service:
GET,POST,DELETE/{Workspace}/ExternalConnection/{ObjectId}
GET/{Workspace}/ExternalConnection
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Integration;

namespace Field2Office.API.Model.Integration
{
    ///<summary>
    ///Used to register connection details for external systems. Supported ConnectionTypes: 'Database'.   Supported DatabaseTypes: 'SqlServer'
    ///</summary>
    public partial class ExternalConnection
    {
        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string ConnectionType { get; set; }
        public virtual string DatabaseType { get; set; }
        public virtual string Server { get; set; }
        public virtual string Port { get; set; }
        public virtual string Database { get; set; }
        public virtual string UserId { get; set; }
        public virtual string Password { get; set; }
        public virtual string AuthorizationType { get; set; }
        public virtual string BaseUrl { get; set; }
        public virtual string HttpHeaders { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual bool HasCredentials { get; set; }
    }

}

C# ExternalConnection DTOs

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

HTTP + JSV

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

POST /{Workspace}/ExternalConnection/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	ObjectId: String,
	Name: String,
	Description: String,
	ConnectionType: String,
	DatabaseType: String,
	Server: String,
	Port: String,
	Database: String,
	UserId: String,
	Password: String,
	AuthorizationType: String,
	BaseUrl: String,
	HttpHeaders: String,
	LastUpdated: String,
	HasCredentials: False
}