| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,OPTIONS | /v1/FFAgentConfig |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal
Namespace Global
Namespace CRM.AgencyPlatform.API.Internal
Public Partial Class FFAgentConfig
Public Overridable Property Id As Guid
Public Overridable Property AgentId As Integer
Public Overridable Property DateCreated As Date
Public Overridable Property DateModified As Date
End Class
Public Partial Class FFAgentConfigExtended
Inherits FFAgentConfig
Public Overridable Property FFSections As List(Of FFSectionExtended) = New List(Of FFSectionExtended)
End Class
Public Partial Class FFAgentConfigRequest
Public Overridable Property FFAgentConfig As FFAgentConfigExtended
End Class
Public Partial Class FFAgentConfigResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property FFAgentConfig As FFAgentConfigExtended
End Class
Public Partial Class FFField
Public Overridable Property Id As Guid
Public Overridable Property FFSectionId As Guid
Public Overridable Property FieldTypeId As Integer
Public Overridable Property x As Integer
Public Overridable Property y As Integer
Public Overridable Property height As Integer
Public Overridable Property width As Integer
Public Overridable Property Text As String
End Class
Public Partial Class FFFieldExtended
Inherits FFField
Public Overridable Property Name As String
Public Overridable Property IsYesNo As Boolean
End Class
Public Partial Class FFSection
Public Overridable Property Id As Guid
Public Overridable Property FFAgentConfigId As Guid
Public Overridable Property SectionTypeId As Integer
Public Overridable Property Nickname As String
Public Overridable Property ShowHeader As Boolean
Public Overridable Property Header As String
Public Overridable Property height As Integer
Public Overridable Property width As Integer
Public Overridable Property x As Integer
Public Overridable Property y As Integer
Public Overridable Property IsActive As Boolean
Public Overridable Property HasBorder As Boolean
Public Overridable Property BorderColor As String
Public Overridable Property BorderWidth As Integer
Public Overridable Property BorderRadius As Integer
Public Overridable Property DateCreated As Date
Public Overridable Property DateModified As Date
End Class
Public Partial Class FFSectionExtended
Inherits FFSection
Public Overridable Property SectionTypeDesc As String
Public Overridable Property FFFields As List(Of FFFieldExtended) = New List(Of FFFieldExtended)
End Class
End Namespace
End Namespace
VB.NET FFAgentConfigRequest DTOs
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.
POST /v1/FFAgentConfig HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FFAgentConfig:
{
FFSections:
[
{
SectionTypeDesc: String,
FFFields:
[
{
Name: String,
IsYesNo: False,
Id: 00000000000000000000000000000000,
FFSectionId: 00000000000000000000000000000000,
FieldTypeId: 0,
x: 0,
y: 0,
height: 0,
width: 0,
Text: String
}
],
Id: 00000000000000000000000000000000,
FFAgentConfigId: 00000000000000000000000000000000,
SectionTypeId: 0,
Nickname: String,
ShowHeader: False,
Header: String,
height: 0,
width: 0,
x: 0,
y: 0,
IsActive: False,
HasBorder: False,
BorderColor: String,
BorderWidth: 0,
BorderRadius: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
],
Id: 00000000000000000000000000000000,
AgentId: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
FFAgentConfig:
{
FFSections:
[
{
SectionTypeDesc: String,
FFFields:
[
{
Name: String,
IsYesNo: False,
Id: 00000000000000000000000000000000,
FFSectionId: 00000000000000000000000000000000,
FieldTypeId: 0,
x: 0,
y: 0,
height: 0,
width: 0,
Text: String
}
],
Id: 00000000000000000000000000000000,
FFAgentConfigId: 00000000000000000000000000000000,
SectionTypeId: 0,
Nickname: String,
ShowHeader: False,
Header: String,
height: 0,
width: 0,
x: 0,
y: 0,
IsActive: False,
HasBorder: False,
BorderColor: String,
BorderWidth: 0,
BorderRadius: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
],
Id: 00000000000000000000000000000000,
AgentId: 0,
DateCreated: 0001-01-01,
DateModified: 0001-01-01
}
}