Trendsic Platform Service

<back to all web services

BranchApptCreateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/queue/appointments
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 BranchApptCreateRequest
            Public Overridable Property LocationId As Guid
            Public Overridable Property [Date] As String
            Public Overridable Property StartLocal As String
            Public Overridable Property LineIds As List(Of Guid) = New List(Of Guid)
            Public Overridable Property ContactId As Integer?
            Public Overridable Property NewContact As BranchApptNewContact
            Public Overridable Property Via As String
            Public Overridable Property Notify As Boolean
            Public Overridable Property Note As String
            Public Overridable Property Overbook As Boolean
        End Class

        Public Partial Class BranchApptNewContact
            Public Overridable Property Name As String
            Public Overridable Property Phone As String
            Public Overridable Property Email As String
        End Class

        Public Partial Class BranchApptWriteResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property CalendarEventId As Integer
            Public Overridable Property CheckInId As Guid
            Public Overridable Property StartLocal As Date?
            Public Overridable Property EndLocal As Date?
            Public Overridable Property ContactId As Integer
            Public Overridable Property ContactExisted As Boolean
            Public Overridable Property Notified As Boolean
            Public Overridable Property Open As Integer?
            Public Overridable Property Capacity As Integer?
        End Class
    End Namespace
End Namespace

VB.NET BranchApptCreateRequest 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 /v1/queue/appointments HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	LocationId: 00000000000000000000000000000000,
	Date: String,
	StartLocal: String,
	LineIds: 
	[
		00000000000000000000000000000000
	],
	ContactId: 0,
	NewContact: 
	{
		Name: String,
		Phone: String,
		Email: String
	},
	Via: String,
	Notify: False,
	Note: String,
	Overbook: False
}
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
		}
	},
	CalendarEventId: 0,
	CheckInId: 00000000000000000000000000000000,
	StartLocal: 0001-01-01,
	EndLocal: 0001-01-01,
	ContactId: 0,
	ContactExisted: False,
	Notified: False,
	Open: 0,
	Capacity: 0
}