Trendsic Platform Service

CustomerCheckins

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET,POST,DELETE,OPTIONS	/v1/CustomerCheckins/{Id}
GET,POST,DELETE,OPTIONS	/v1/CustomerCheckins

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 CheckinInformation
            Public Overridable Property Id As Guid
            Public Overridable Property LocationId As Guid
            Public Overridable Property LocationName As String
            Public Overridable Property CustomerId As Guid?
            Public Overridable Property QuestionnaireSubmitted As Boolean?
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property TotalServiceDurationMinutes As Integer
            Public Overridable Property TotalCost As Decimal
            Public Overridable Property SendQuestionnaire As Boolean
            Public Overridable Property RequireUpload As Boolean
            Public Overridable Property Questions As List(Of LineQuestion) = New List(Of LineQuestion)
            Public Overridable Property Lines As List(Of Line) = New List(Of Line)
        End Class

        Public Partial Class CustomerCheckinObject
            Public Overridable Property Id As Guid
            Public Overridable Property LineId As Guid
            Public Overridable Property CustomerId As Guid
            Public Overridable Property EmployeeId As Guid
            Public Overridable Property LocationId As Guid
            Public Overridable Property StationId As Guid
            Public Overridable Property SignInTime As Date
            Public Overridable Property AdjustedSignInTime As Date
            Public Overridable Property SendReminders As Boolean
            Public Overridable Property Status As Integer
            Public Overridable Property TaskTime As Integer
            Public Overridable Property Completed As Boolean
            Public Overridable Property CompletedTime As Date
            Public Overridable Property QuestionnaireSubmitted As Boolean
            Public Overridable Property LineIds As List(Of Guid) = New List(Of Guid)
        End Class

        Public Partial Class CustomerCheckins
            Inherits CustomerCheckinObject
            Public Overridable Property ApiKey As Guid
        End Class

        Public Partial Class CustomerCheckinsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property CustomerCheckins As List(Of CustomerCheckinObject) = New List(Of CustomerCheckinObject)
            Public Overridable Property CustomerCheckinRequirements As CheckinInformation
        End Class

        Public Partial Class Line
            Public Overridable Property Id As Guid
            Public Overridable Property LocationId As Guid
            Public Overridable Property LocationName As String
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property ServiceDurationMinutes As Integer
            Public Overridable Property WaitTime As Integer
            Public Overridable Property Cost As Decimal
            Public Overridable Property UpperThreshold As Integer?
            Public Overridable Property LowerThreshold As Integer?
            Public Overridable Property Active As Boolean
            Public Overridable Property EntDate As Date?
            Public Overridable Property ModDate As Date?
            Public Overridable Property SendQuestionnaire As Boolean
            Public Overridable Property RequireUpload As Boolean
            Public Overridable Property UploadMessage As String
            Public Overridable Property LineImages As List(Of LineImage) = New List(Of LineImage)
        End Class

        Public Partial Class LineImage
            Public Overridable Property ImageId As Guid?
            Public Overridable Property FileName As String
            Public Overridable Property ImageTitle As String
            Public Overridable Property UploadDate As Date
        End Class

        Public Partial Class LineQuestion
            Public Overridable Property Id As Integer
            Public Overridable Property CustomerCheckInId As Guid
            Public Overridable Property LineId As Guid
            Public Overridable Property Question As String
            Public Overridable Property Answer As String
            Public Overridable Property Active As Boolean
        End Class
    End Namespace
End Namespace

VB.NET CustomerCheckins 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/CustomerCheckins/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	LineId: 00000000000000000000000000000000,
	CustomerId: 00000000000000000000000000000000,
	EmployeeId: 00000000000000000000000000000000,
	LocationId: 00000000000000000000000000000000,
	StationId: 00000000000000000000000000000000,
	SignInTime: 0001-01-01,
	AdjustedSignInTime: 0001-01-01,
	SendReminders: False,
	Status: 0,
	TaskTime: 0,
	Completed: False,
	CompletedTime: 0001-01-01,
	QuestionnaireSubmitted: False,
	LineIds: 
	[
		00000000000000000000000000000000
	]
}

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
		}
	},
	CustomerCheckins: 
	[
		{
			Id: 00000000000000000000000000000000,
			LineId: 00000000000000000000000000000000,
			CustomerId: 00000000000000000000000000000000,
			EmployeeId: 00000000000000000000000000000000,
			LocationId: 00000000000000000000000000000000,
			StationId: 00000000000000000000000000000000,
			SignInTime: 0001-01-01,
			AdjustedSignInTime: 0001-01-01,
			SendReminders: False,
			Status: 0,
			TaskTime: 0,
			Completed: False,
			CompletedTime: 0001-01-01,
			QuestionnaireSubmitted: False,
			LineIds: 
			[
				00000000000000000000000000000000
			]
		}
	],
	CustomerCheckinRequirements: 
	{
		Id: 00000000000000000000000000000000,
		LocationId: 00000000000000000000000000000000,
		LocationName: String,
		CustomerId: 00000000000000000000000000000000,
		QuestionnaireSubmitted: False,
		Name: String,
		Description: String,
		TotalServiceDurationMinutes: 0,
		TotalCost: 0,
		SendQuestionnaire: False,
		RequireUpload: False,
		Questions: 
		[
			{
				Id: 0,
				CustomerCheckInId: 00000000000000000000000000000000,
				LineId: 00000000000000000000000000000000,
				Question: String,
				Answer: String,
				Active: False
			}
		],
		Lines: 
		[
			{
				Id: 00000000000000000000000000000000,
				LocationId: 00000000000000000000000000000000,
				LocationName: String,
				Name: String,
				Description: String,
				ServiceDurationMinutes: 0,
				WaitTime: 0,
				Cost: 0,
				UpperThreshold: 0,
				LowerThreshold: 0,
				Active: False,
				EntDate: 0001-01-01,
				ModDate: 0001-01-01,
				SendQuestionnaire: False,
				RequireUpload: False,
				UploadMessage: String,
				LineImages: 
				[
					{
						ImageId: 00000000000000000000000000000000,
						FileName: String,
						ImageTitle: String,
						UploadDate: 0001-01-01
					}
				]
			}
		]
	}
}