Field Squared API 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

namespace Field2Office.API.Model.Integration

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

    ///<summary>
    ///Used to register connection details for external systems. Supported ConnectionTypes: 'Database'.   Supported DatabaseTypes: 'SqlServer'
    ///</summary>
    [<AllowNullLiteral>]
    type ExternalConnection() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val ConnectionType:String = null with get,set
        member val DatabaseType:String = null with get,set
        member val Server:String = null with get,set
        member val Port:String = null with get,set
        member val Database:String = null with get,set
        member val UserId:String = null with get,set
        member val Password:String = null with get,set
        member val AuthorizationType:String = null with get,set
        member val BaseUrl:String = null with get,set
        member val HttpHeaders:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val HasCredentials:Boolean = new Boolean() with get,set

F# ExternalConnection DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ExternalConnection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Integration">
  <AuthorizationType>String</AuthorizationType>
  <BaseUrl>String</BaseUrl>
  <ConnectionType>String</ConnectionType>
  <Database>String</Database>
  <DatabaseType>String</DatabaseType>
  <Description>String</Description>
  <HasCredentials>false</HasCredentials>
  <HttpHeaders>String</HttpHeaders>
  <LastUpdated>String</LastUpdated>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <Password>String</Password>
  <Port>String</Port>
  <Server>String</Server>
  <UserId>String</UserId>
  <Workspace>String</Workspace>
</ExternalConnection>