| GET,POST,DELETE | /{Workspace}/ExternalConnection/{ObjectId} | ||
|---|---|---|---|
| GET | /{Workspace}/ExternalConnection |
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Integration
Namespace Global
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 Overridable Property Workspace As String
Public Overridable Property ObjectId As String
Public Overridable Property Name As String
Public Overridable Property Description As String
Public Overridable Property ConnectionType As String
Public Overridable Property DatabaseType As String
Public Overridable Property Server As String
Public Overridable Property Port As String
Public Overridable Property Database As String
Public Overridable Property UserId As String
Public Overridable Property Password As String
Public Overridable Property AuthorizationType As String
Public Overridable Property BaseUrl As String
Public Overridable Property HttpHeaders As String
Public Overridable Property LastUpdated As String
Public Overridable Property HasCredentials As Boolean
End Class
End Namespace
End Namespace
VB.NET ExternalConnection DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>