| GET | /integrations/{integrationId} |
|---|
namespace Voice.Api
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type EntityInfo() =
///<summary>
///The ID of the object
///</summary>
[<ApiMember(Description="The ID of the object")>]
member val Id:String = null with get,set
///<summary>
///The date the object was created
///</summary>
[<ApiMember(Description="The date the object was created")>]
member val DateCreated:String = null with get,set
///<summary>
///The date the object was last modified
///</summary>
[<ApiMember(Description="The date the object was last modified")>]
member val DateLastModified:String = null with get,set
///<summary>
///The user that created this object
///</summary>
[<ApiMember(Description="The user that created this object")>]
member val CreatedBy:String = null with get,set
///<summary>
///The user that last modified this object
///</summary>
[<ApiMember(Description="The user that last modified this object")>]
member val LastModifiedBy:String = null with get,set
[<AllowNullLiteral>]
type CustomerBreadcrumb() =
member val Id:String = null with get,set
member val Name:String = null with get,set
type IntegrationTypes =
| HostedSuite = 0
| OfficeRnd = 1
| Zoho = 2
type IntegrationStatuses =
| NotConfigured = 0
| Error = 1
| OK = 2
type ValueTypes =
| NotSpecified = 0
| String = 1
| Boolean = 2
| Number = 3
| List = 4
| Struct = 5
| Transition = 6
| Custom = 7
| Date = 8
| AudioFile = 9
| TimeZoneId = 10
| PhoneNumber = 11
| User = 12
| Endpoint = 13
| Time = 14
| File = 15
| FaxNumber = 16
| EmailAccount = 17
| Customer = 18
| Flow = 19
| Team = 20
| FlowReference = 21
| Integration = 22
type UIHints =
| None = 0
| LargeText = 1
| InlineForm = 2
| Password = 3
| InlineStruct = 4
[<AllowNullLiteral>]
type Struct() =
inherit Dictionary<String, Value>()
[<AllowNullLiteral>]
type Value() =
member val BoolValue:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val StringValue:String = null with get,set
member val NumberValue:Nullable<Double> = new Nullable<Double>() with get,set
member val ListValue:ResizeArray<Struct> = new ResizeArray<Struct>() with get,set
member val StructValue:Struct = null with get,set
type DataFieldUniqueness =
| NotUnique = 0
| Unique = 1
| UniqueToCustomer = 2
type UserDataFieldModes =
| Hidden = 0
| ReadOnly = 1
| ReadWrite = 2
[<AllowNullLiteral>]
type DataField() =
member val Id:String = null with get,set
member val Name:String = null with get,set
member val Type:ValueTypes = new ValueTypes() with get,set
member val UIHint:UIHints = new UIHints() with get,set
member val UITab:String = null with get,set
member val IsAsync:Boolean = new Boolean() with get,set
member val DisableBinding:Boolean = new Boolean() with get,set
member val StructType:DataType = null with get,set
member val ListType:DataType = null with get,set
member val Description:String = null with get,set
member val PossibleValues:ResizeArray<String> = new ResizeArray<String>() with get,set
member val IsOutput:Boolean = new Boolean() with get,set
member val CustomFieldValuesUrl:String = null with get,set
member val DefaultValue:Value = null with get,set
member val TransitionNameFormat:String = null with get,set
member val Uniqueness:DataFieldUniqueness = new DataFieldUniqueness() with get,set
member val VoiceOnly:Boolean = new Boolean() with get,set
member val ConditionalVisibilityField:String = null with get,set
member val ConditionalVisibilityValue:String = null with get,set
member val NoEvalTemplate:Boolean = new Boolean() with get,set
member val UserMode:UserDataFieldModes = new UserDataFieldModes() with get,set
member val AnyValueType:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type DataType() =
member val TypeName:String = null with get,set
member val Fields:ResizeArray<DataField> = new ResizeArray<DataField>() with get,set
type IntegrationFeatures =
| CrmSync = 0
| OAuth2 = 1
[<AllowNullLiteral>]
type IntegrationInfo() =
inherit EntityInfo()
///<summary>
///The ID of the account associated with this integration
///</summary>
[<ApiMember(Description="The ID of the account associated with this integration")>]
member val AccountId:String = null with get,set
///<summary>
///The ID of the customer this integration is associated with
///</summary>
[<ApiMember(Description="The ID of the customer this integration is associated with")>]
member val CustomerId:String = null with get,set
///<summary>
///The name of the customer this integration is associated with
///</summary>
[<ApiMember(Description="The name of the customer this integration is associated with")>]
member val CustomerName:String = null with get,set
///<summary>
///The date the integration was sync'd last
///</summary>
[<ApiMember(Description="The date the integration was sync'd last")>]
member val DateLastSync:String = null with get,set
///<summary>
///The breadcrumb to the customer for this integration
///</summary>
[<ApiMember(Description="The breadcrumb to the customer for this integration")>]
member val CustomerBreadcrumb:ResizeArray<CustomerBreadcrumb> = new ResizeArray<CustomerBreadcrumb>() with get,set
///<summary>
///The name of the integration (e.g. HostedSuite Dallas)
///</summary>
[<ApiMember(Description="The name of the integration (e.g. HostedSuite Dallas)")>]
member val Name:String = null with get,set
///<summary>
///Automatically create new customers / users when sync'ing with CRM?
///</summary>
[<ApiMember(Description="Automatically create new customers / users when sync'ing with CRM?")>]
member val AutomaticallyCreateCustomers:Boolean = new Boolean() with get,set
///<summary>
///The type of integration
///</summary>
[<ApiMember(Description="The type of integration")>]
member val Type:IntegrationTypes = new IntegrationTypes() with get,set
///<summary>
///The status of the integration
///</summary>
[<ApiMember(Description="The status of the integration")>]
member val Status:IntegrationStatuses = new IntegrationStatuses() with get,set
///<summary>
///The status of the integration
///</summary>
[<ApiMember(Description="The status of the integration")>]
member val StatusMessage:String = null with get,set
///<summary>
///The settings type for this integration
///</summary>
[<ApiMember(Description="The settings type for this integration")>]
member val SettingsDataType:DataType = null with get,set
///<summary>
///The settings for this integration
///</summary>
[<ApiMember(Description="The settings for this integration")>]
member val Settings:Struct = null with get,set
///<summary>
///The features supported by this integration
///</summary>
[<ApiMember(Description="The features supported by this integration")>]
member val Features:ResizeArray<IntegrationFeatures> = new ResizeArray<IntegrationFeatures>() with get,set
///<summary>
///Is this integration authorized (OAuth)?
///</summary>
[<ApiMember(Description="Is this integration authorized (OAuth)?")>]
member val IsAuthorized:Boolean = new Boolean() with get,set
///<summary>
///Get a specific integration
///</summary>
[<Api(Description="Get a specific integration")>]
[<AllowNullLiteral>]
type GetIntegration() =
interface IGet
///<summary>
///The ID of the integration you want to get
///</summary>
[<ApiMember(Description="The ID of the integration you want to get")>]
member val IntegrationId:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /integrations/{integrationId} HTTP/1.1
Host: evovoice.io
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
accountId: String,
customerId: String,
customerName: String,
dateLastSync: String,
customerBreadcrumb:
[
{
id: String,
name: String
}
],
name: String,
automaticallyCreateCustomers: False,
type: HostedSuite,
status: NotConfigured,
statusMessage: String,
settingsDataType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
listType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
listType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
structType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
listType:
{
typeName: String,
fields:
[
{
id: String,
name: String,
type: NotSpecified,
uiHint: None,
uiTab: String,
isAsync: False,
disableBinding: False,
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
description: String,
possibleValues:
[
String
],
isOutput: False,
customFieldValuesUrl: String,
defaultValue:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
}
],
structValue: {}
}
}
}
}
},
transitionNameFormat: String,
uniqueness: NotUnique,
voiceOnly: False,
conditionalVisibilityField: String,
conditionalVisibilityValue: String,
noEvalTemplate: False,
userMode: Hidden,
anyValueType: False
}
]
},
settings:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
null
]
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
null
]
}
}
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
null
]
}
}
],
structValue:
{
String:
{
boolValue: False,
stringValue: String,
numberValue: 0,
listValue:
[
null
]
}
}
}
}
}
},
features:
[
CrmSync
],
isAuthorized: False,
id: String,
dateCreated: String,
dateLastModified: String,
createdBy: String,
lastModifiedBy: String
}