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
import Foundation
import ServiceStack

public class BranchApptCreateRequest : Codable
{
    public var locationId:String
    public var date:String
    public var startLocal:String
    public var lineIds:[String] = []
    public var contactId:Int?
    public var newContact:BranchApptNewContact
    public var via:String
    public var notify:Bool
    public var note:String
    public var overbook:Bool

    required public init(){}
}

public class BranchApptNewContact : Codable
{
    public var name:String
    public var phone:String
    public var email:String

    required public init(){}
}

public class BranchApptWriteResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var calendarEventId:Int
    public var checkInId:String
    public var startLocal:Date?
    public var endLocal:Date?
    public var contactId:Int
    public var contactExisted:Bool
    public var notified:Bool
    public var open:Int?
    public var capacity:Int?

    required public init(){}
}


Swift 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
}