Trendsic Platform Service

<back to all web services

CustomerCheckinsRequest

The following routes are available for this service:
GET,POST,DELETE,OPTIONS/v1/CustomerCheckins/GetSingle/{Id}
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 CustomerCheckinObject() = 
        member val Id:Guid = new Guid() with get,set
        member val LineId:Guid = new Guid() with get,set
        member val CustomerId:Guid = new Guid() with get,set
        member val EmployeeId:Guid = new Guid() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val StationId:Guid = new Guid() with get,set
        member val SignInTime:DateTime = new DateTime() with get,set
        member val AdjustedSignInTime:DateTime = new DateTime() with get,set
        member val SendReminders:Boolean = new Boolean() with get,set
        member val Status:Int32 = new Int32() with get,set
        member val TaskTime:Int32 = new Int32() with get,set
        member val Completed:Boolean = new Boolean() with get,set
        member val CompletedTime:DateTime = new DateTime() with get,set
        member val QuestionnaireSubmitted:Boolean = new Boolean() with get,set
        member val LineIds:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set

    [<AllowNullLiteral>]
    type LineQuestion() = 
        member val Id:Int32 = new Int32() with get,set
        member val CustomerCheckInId:Guid = new Guid() with get,set
        member val LineId:Guid = new Guid() with get,set
        member val Question:String = null with get,set
        member val Answer:String = null with get,set
        member val Active:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type LineImage() = 
        member val ImageId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val FileName:String = null with get,set
        member val ImageTitle:String = null with get,set
        member val UploadDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type Line() = 
        member val Id:Guid = new Guid() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val LocationName:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val ServiceDurationMinutes:Int32 = new Int32() with get,set
        member val WaitTime:Int32 = new Int32() with get,set
        member val Cost:Decimal = new Decimal() with get,set
        member val UpperThreshold:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LowerThreshold:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val EntDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ModDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SendQuestionnaire:Boolean = new Boolean() with get,set
        member val RequireUpload:Boolean = new Boolean() with get,set
        member val UploadMessage:String = null with get,set
        member val LineImages:ResizeArray<LineImage> = new ResizeArray<LineImage>() with get,set

    [<AllowNullLiteral>]
    type CheckinInformation() = 
        member val Id:Guid = new Guid() with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val LocationName:String = null with get,set
        member val CustomerId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val QuestionnaireSubmitted:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val TotalServiceDurationMinutes:Int32 = new Int32() with get,set
        member val TotalCost:Decimal = new Decimal() with get,set
        member val SendQuestionnaire:Boolean = new Boolean() with get,set
        member val RequireUpload:Boolean = new Boolean() with get,set
        member val Questions:ResizeArray<LineQuestion> = new ResizeArray<LineQuestion>() with get,set
        member val Lines:ResizeArray<Line> = new ResizeArray<Line>() with get,set

    [<AllowNullLiteral>]
    type CustomerCheckinsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val CustomerCheckins:ResizeArray<CustomerCheckinObject> = new ResizeArray<CustomerCheckinObject>() with get,set
        member val CustomerCheckinRequirements:CheckinInformation = null with get,set

    [<AllowNullLiteral>]
    type CustomerCheckinsRequest() = 
        inherit CustomerCheckinObject()

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

{
	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
					}
				]
			}
		]
	}
}