Trendsic Platform Service

<back to all web services

BranchApptChangeRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/queue/appointments/{CheckInId}/change
namespace CRM.AgencyPlatform.API.Internal

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

    [<AllowNullLiteral>]
    type BranchApptWriteResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val CalendarEventId:Int32 = new Int32() with get,set
        member val CheckInId:Guid = new Guid() with get,set
        member val StartLocal:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndLocal:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ContactId:Int32 = new Int32() with get,set
        member val ContactExisted:Boolean = new Boolean() with get,set
        member val Notified:Boolean = new Boolean() with get,set
        member val Open:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Capacity:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type BranchApptChangeRequest() = 
        member val CheckInId:Guid = new Guid() with get,set
        member val Date:String = null with get,set
        member val StartLocal:String = null with get,set
        member val LineIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
        member val Notify:Boolean = new Boolean() with get,set
        member val Reason:String = null with get,set
        member val Note:String = null with get,set
        member val Overbook:Boolean = new Boolean() with get,set

F# BranchApptChangeRequest 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/{CheckInId}/change HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CheckInId: 00000000000000000000000000000000,
	Date: String,
	StartLocal: String,
	LineIds: 
	[
		00000000000000000000000000000000
	],
	Notify: False,
	Reason: String,
	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
}