Trendsic Platform Service

<back to all web services

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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class CheckinInformation
    {
        public virtual Guid Id { get; set; }
        public virtual Guid LocationId { get; set; }
        public virtual string LocationName { get; set; }
        public virtual Guid? CustomerId { get; set; }
        public virtual bool? QuestionnaireSubmitted { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual int TotalServiceDurationMinutes { get; set; }
        public virtual decimal TotalCost { get; set; }
        public virtual bool SendQuestionnaire { get; set; }
        public virtual bool RequireUpload { get; set; }
        public virtual List<LineQuestion> Questions { get; set; } = [];
        public virtual List<Line> Lines { get; set; } = [];
    }

    public partial class CustomerCheckinObject
    {
        public virtual Guid Id { get; set; }
        public virtual Guid LineId { get; set; }
        public virtual Guid CustomerId { get; set; }
        public virtual Guid EmployeeId { get; set; }
        public virtual Guid LocationId { get; set; }
        public virtual Guid StationId { get; set; }
        public virtual DateTime SignInTime { get; set; }
        public virtual DateTime AdjustedSignInTime { get; set; }
        public virtual bool SendReminders { get; set; }
        public virtual int Status { get; set; }
        public virtual int TaskTime { get; set; }
        public virtual bool Completed { get; set; }
        public virtual DateTime CompletedTime { get; set; }
        public virtual bool QuestionnaireSubmitted { get; set; }
        public virtual List<Guid> LineIds { get; set; } = [];
    }

    public partial class CustomerCheckins
        : CustomerCheckinObject
    {
        public virtual Guid ApiKey { get; set; }
    }

    public partial class CustomerCheckinsResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<CustomerCheckinObject> CustomerCheckins { get; set; } = [];
        public virtual CheckinInformation CustomerCheckinRequirements { get; set; }
    }

    public partial class Line
    {
        public virtual Guid Id { get; set; }
        public virtual Guid LocationId { get; set; }
        public virtual string LocationName { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual int ServiceDurationMinutes { get; set; }
        public virtual int WaitTime { get; set; }
        public virtual decimal Cost { get; set; }
        public virtual int? UpperThreshold { get; set; }
        public virtual int? LowerThreshold { get; set; }
        public virtual bool Active { get; set; }
        public virtual DateTime? EntDate { get; set; }
        public virtual DateTime? ModDate { get; set; }
        public virtual bool SendQuestionnaire { get; set; }
        public virtual bool RequireUpload { get; set; }
        public virtual string UploadMessage { get; set; }
        public virtual List<LineImage> LineImages { get; set; } = [];
    }

    public partial class LineImage
    {
        public virtual Guid? ImageId { get; set; }
        public virtual string FileName { get; set; }
        public virtual string ImageTitle { get; set; }
        public virtual DateTime UploadDate { get; set; }
    }

    public partial class LineQuestion
    {
        public virtual int Id { get; set; }
        public virtual Guid CustomerCheckInId { get; set; }
        public virtual Guid LineId { get; set; }
        public virtual string Question { get; set; }
        public virtual string Answer { get; set; }
        public virtual bool Active { get; set; }
    }

}

C# CustomerCheckins DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ApiKey":"00000000000000000000000000000000","Id":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","CustomerId":"00000000000000000000000000000000","EmployeeId":"00000000000000000000000000000000","LocationId":"00000000000000000000000000000000","StationId":"00000000000000000000000000000000","SignInTime":"0001-01-01T00:00:00.0000000","AdjustedSignInTime":"0001-01-01T00:00:00.0000000","SendReminders":false,"Status":0,"TaskTime":0,"Completed":false,"CompletedTime":"0001-01-01T00:00:00.0000000","QuestionnaireSubmitted":false,"LineIds":["00000000000000000000000000000000"]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","AdjustedSignInTime":"0001-01-01T00:00:00.0000000","SendReminders":false,"Status":0,"TaskTime":0,"Completed":false,"CompletedTime":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000","SendQuestionnaire":false,"RequireUpload":false,"UploadMessage":"String","LineImages":[{"ImageId":"00000000000000000000000000000000","FileName":"String","ImageTitle":"String","UploadDate":"0001-01-01T00:00:00.0000000"}]}]}}