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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CustomerCheckins extends CustomerCheckinObject
    {
        public UUID ApiKey = null;
        
        public UUID getApiKey() { return ApiKey; }
        public CustomerCheckins setApiKey(UUID value) { this.ApiKey = value; return this; }
    }

    public static class CustomerCheckinObject
    {
        public UUID Id = null;
        public UUID LineId = null;
        public UUID CustomerId = null;
        public UUID EmployeeId = null;
        public UUID LocationId = null;
        public UUID StationId = null;
        public Date SignInTime = null;
        public Date AdjustedSignInTime = null;
        public Boolean SendReminders = null;
        public Integer Status = null;
        public Integer TaskTime = null;
        public Boolean Completed = null;
        public Date CompletedTime = null;
        public Boolean QuestionnaireSubmitted = null;
        public ArrayList<UUID> LineIds = new ArrayList<UUID>();
        
        public UUID getId() { return Id; }
        public CustomerCheckinObject setId(UUID value) { this.Id = value; return this; }
        public UUID getLineId() { return LineId; }
        public CustomerCheckinObject setLineId(UUID value) { this.LineId = value; return this; }
        public UUID getCustomerId() { return CustomerId; }
        public CustomerCheckinObject setCustomerId(UUID value) { this.CustomerId = value; return this; }
        public UUID getEmployeeId() { return EmployeeId; }
        public CustomerCheckinObject setEmployeeId(UUID value) { this.EmployeeId = value; return this; }
        public UUID getLocationId() { return LocationId; }
        public CustomerCheckinObject setLocationId(UUID value) { this.LocationId = value; return this; }
        public UUID getStationId() { return StationId; }
        public CustomerCheckinObject setStationId(UUID value) { this.StationId = value; return this; }
        public Date getSignInTime() { return SignInTime; }
        public CustomerCheckinObject setSignInTime(Date value) { this.SignInTime = value; return this; }
        public Date getAdjustedSignInTime() { return AdjustedSignInTime; }
        public CustomerCheckinObject setAdjustedSignInTime(Date value) { this.AdjustedSignInTime = value; return this; }
        public Boolean isSendReminders() { return SendReminders; }
        public CustomerCheckinObject setSendReminders(Boolean value) { this.SendReminders = value; return this; }
        public Integer getStatus() { return Status; }
        public CustomerCheckinObject setStatus(Integer value) { this.Status = value; return this; }
        public Integer getTaskTime() { return TaskTime; }
        public CustomerCheckinObject setTaskTime(Integer value) { this.TaskTime = value; return this; }
        public Boolean isCompleted() { return Completed; }
        public CustomerCheckinObject setCompleted(Boolean value) { this.Completed = value; return this; }
        public Date getCompletedTime() { return CompletedTime; }
        public CustomerCheckinObject setCompletedTime(Date value) { this.CompletedTime = value; return this; }
        public Boolean isQuestionnaireSubmitted() { return QuestionnaireSubmitted; }
        public CustomerCheckinObject setQuestionnaireSubmitted(Boolean value) { this.QuestionnaireSubmitted = value; return this; }
        public ArrayList<UUID> getLineIds() { return LineIds; }
        public CustomerCheckinObject setLineIds(ArrayList<UUID> value) { this.LineIds = value; return this; }
    }

    public static class CustomerCheckinsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<CustomerCheckinObject> CustomerCheckins = new ArrayList<CustomerCheckinObject>();
        public CheckinInformation CustomerCheckinRequirements = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CustomerCheckinsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<CustomerCheckinObject> getCustomerCheckins() { return CustomerCheckins; }
        public CustomerCheckinsResponse setCustomerCheckins(ArrayList<CustomerCheckinObject> value) { this.CustomerCheckins = value; return this; }
        public CheckinInformation getCustomerCheckinRequirements() { return CustomerCheckinRequirements; }
        public CustomerCheckinsResponse setCustomerCheckinRequirements(CheckinInformation value) { this.CustomerCheckinRequirements = value; return this; }
    }

    public static class CheckinInformation
    {
        public UUID Id = null;
        public UUID LocationId = null;
        public String LocationName = null;
        public UUID CustomerId = null;
        public Boolean QuestionnaireSubmitted = null;
        public String Name = null;
        public String Description = null;
        public Integer TotalServiceDurationMinutes = null;
        public BigDecimal TotalCost = null;
        public Boolean SendQuestionnaire = null;
        public Boolean RequireUpload = null;
        public ArrayList<LineQuestion> Questions = new ArrayList<LineQuestion>();
        public ArrayList<Line> Lines = new ArrayList<Line>();
        
        public UUID getId() { return Id; }
        public CheckinInformation setId(UUID value) { this.Id = value; return this; }
        public UUID getLocationId() { return LocationId; }
        public CheckinInformation setLocationId(UUID value) { this.LocationId = value; return this; }
        public String getLocationName() { return LocationName; }
        public CheckinInformation setLocationName(String value) { this.LocationName = value; return this; }
        public UUID getCustomerId() { return CustomerId; }
        public CheckinInformation setCustomerId(UUID value) { this.CustomerId = value; return this; }
        public Boolean isQuestionnaireSubmitted() { return QuestionnaireSubmitted; }
        public CheckinInformation setQuestionnaireSubmitted(Boolean value) { this.QuestionnaireSubmitted = value; return this; }
        public String getName() { return Name; }
        public CheckinInformation setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public CheckinInformation setDescription(String value) { this.Description = value; return this; }
        public Integer getTotalServiceDurationMinutes() { return TotalServiceDurationMinutes; }
        public CheckinInformation setTotalServiceDurationMinutes(Integer value) { this.TotalServiceDurationMinutes = value; return this; }
        public BigDecimal getTotalCost() { return TotalCost; }
        public CheckinInformation setTotalCost(BigDecimal value) { this.TotalCost = value; return this; }
        public Boolean isSendQuestionnaire() { return SendQuestionnaire; }
        public CheckinInformation setSendQuestionnaire(Boolean value) { this.SendQuestionnaire = value; return this; }
        public Boolean isRequireUpload() { return RequireUpload; }
        public CheckinInformation setRequireUpload(Boolean value) { this.RequireUpload = value; return this; }
        public ArrayList<LineQuestion> getQuestions() { return Questions; }
        public CheckinInformation setQuestions(ArrayList<LineQuestion> value) { this.Questions = value; return this; }
        public ArrayList<Line> getLines() { return Lines; }
        public CheckinInformation setLines(ArrayList<Line> value) { this.Lines = value; return this; }
    }

    public static class LineQuestion
    {
        public Integer Id = null;
        public UUID CustomerCheckInId = null;
        public UUID LineId = null;
        public String Question = null;
        public String Answer = null;
        public Boolean Active = null;
        
        public Integer getId() { return Id; }
        public LineQuestion setId(Integer value) { this.Id = value; return this; }
        public UUID getCustomerCheckInId() { return CustomerCheckInId; }
        public LineQuestion setCustomerCheckInId(UUID value) { this.CustomerCheckInId = value; return this; }
        public UUID getLineId() { return LineId; }
        public LineQuestion setLineId(UUID value) { this.LineId = value; return this; }
        public String getQuestion() { return Question; }
        public LineQuestion setQuestion(String value) { this.Question = value; return this; }
        public String getAnswer() { return Answer; }
        public LineQuestion setAnswer(String value) { this.Answer = value; return this; }
        public Boolean isActive() { return Active; }
        public LineQuestion setActive(Boolean value) { this.Active = value; return this; }
    }

    public static class Line
    {
        public UUID Id = null;
        public UUID LocationId = null;
        public String LocationName = null;
        public String Name = null;
        public String Description = null;
        public Integer ServiceDurationMinutes = null;
        public Integer WaitTime = null;
        public BigDecimal Cost = null;
        public Integer UpperThreshold = null;
        public Integer LowerThreshold = null;
        public Boolean Active = null;
        public Date EntDate = null;
        public Date ModDate = null;
        public Boolean SendQuestionnaire = null;
        public Boolean RequireUpload = null;
        public String UploadMessage = null;
        public ArrayList<LineImage> LineImages = new ArrayList<LineImage>();
        
        public UUID getId() { return Id; }
        public Line setId(UUID value) { this.Id = value; return this; }
        public UUID getLocationId() { return LocationId; }
        public Line setLocationId(UUID value) { this.LocationId = value; return this; }
        public String getLocationName() { return LocationName; }
        public Line setLocationName(String value) { this.LocationName = value; return this; }
        public String getName() { return Name; }
        public Line setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public Line setDescription(String value) { this.Description = value; return this; }
        public Integer getServiceDurationMinutes() { return ServiceDurationMinutes; }
        public Line setServiceDurationMinutes(Integer value) { this.ServiceDurationMinutes = value; return this; }
        public Integer getWaitTime() { return WaitTime; }
        public Line setWaitTime(Integer value) { this.WaitTime = value; return this; }
        public BigDecimal getCost() { return Cost; }
        public Line setCost(BigDecimal value) { this.Cost = value; return this; }
        public Integer getUpperThreshold() { return UpperThreshold; }
        public Line setUpperThreshold(Integer value) { this.UpperThreshold = value; return this; }
        public Integer getLowerThreshold() { return LowerThreshold; }
        public Line setLowerThreshold(Integer value) { this.LowerThreshold = value; return this; }
        public Boolean isActive() { return Active; }
        public Line setActive(Boolean value) { this.Active = value; return this; }
        public Date getEntDate() { return EntDate; }
        public Line setEntDate(Date value) { this.EntDate = value; return this; }
        public Date getModDate() { return ModDate; }
        public Line setModDate(Date value) { this.ModDate = value; return this; }
        public Boolean isSendQuestionnaire() { return SendQuestionnaire; }
        public Line setSendQuestionnaire(Boolean value) { this.SendQuestionnaire = value; return this; }
        public Boolean isRequireUpload() { return RequireUpload; }
        public Line setRequireUpload(Boolean value) { this.RequireUpload = value; return this; }
        public String getUploadMessage() { return UploadMessage; }
        public Line setUploadMessage(String value) { this.UploadMessage = value; return this; }
        public ArrayList<LineImage> getLineImages() { return LineImages; }
        public Line setLineImages(ArrayList<LineImage> value) { this.LineImages = value; return this; }
    }

    public static class LineImage
    {
        public UUID ImageId = null;
        public String FileName = null;
        public String ImageTitle = null;
        public Date UploadDate = null;
        
        public UUID getImageId() { return ImageId; }
        public LineImage setImageId(UUID value) { this.ImageId = value; return this; }
        public String getFileName() { return FileName; }
        public LineImage setFileName(String value) { this.FileName = value; return this; }
        public String getImageTitle() { return ImageTitle; }
        public LineImage setImageTitle(String value) { this.ImageTitle = value; return this; }
        public Date getUploadDate() { return UploadDate; }
        public LineImage setUploadDate(Date value) { this.UploadDate = value; return this; }
    }

}

Java CustomerCheckins DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerCheckins xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AdjustedSignInTime>0001-01-01T00:00:00</AdjustedSignInTime>
  <Completed>false</Completed>
  <CompletedTime>0001-01-01T00:00:00</CompletedTime>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <LineId>00000000-0000-0000-0000-000000000000</LineId>
  <LineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </LineIds>
  <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
  <QuestionnaireSubmitted>false</QuestionnaireSubmitted>
  <SendReminders>false</SendReminders>
  <SignInTime>0001-01-01T00:00:00</SignInTime>
  <StationId>00000000-0000-0000-0000-000000000000</StationId>
  <Status>0</Status>
  <TaskTime>0</TaskTime>
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</CustomerCheckins>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerCheckinsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CustomerCheckinRequirements>
    <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
    <Description>String</Description>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Lines>
      <Line>
        <Active>false</Active>
        <Cost>0</Cost>
        <Description>String</Description>
        <EntDate>0001-01-01T00:00:00</EntDate>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <LineImages>
          <LineImage>
            <FileName>String</FileName>
            <ImageId>00000000-0000-0000-0000-000000000000</ImageId>
            <ImageTitle>String</ImageTitle>
            <UploadDate>0001-01-01T00:00:00</UploadDate>
          </LineImage>
        </LineImages>
        <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
        <LocationName>String</LocationName>
        <LowerThreshold>0</LowerThreshold>
        <ModDate>0001-01-01T00:00:00</ModDate>
        <Name>String</Name>
        <RequireUpload>false</RequireUpload>
        <SendQuestionnaire>false</SendQuestionnaire>
        <ServiceDurationMinutes>0</ServiceDurationMinutes>
        <UploadMessage>String</UploadMessage>
        <UpperThreshold>0</UpperThreshold>
        <WaitTime>0</WaitTime>
      </Line>
    </Lines>
    <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
    <LocationName>String</LocationName>
    <Name>String</Name>
    <QuestionnaireSubmitted>false</QuestionnaireSubmitted>
    <Questions>
      <LineQuestion>
        <Active>false</Active>
        <Answer>String</Answer>
        <CustomerCheckInId>00000000-0000-0000-0000-000000000000</CustomerCheckInId>
        <Id>0</Id>
        <LineId>00000000-0000-0000-0000-000000000000</LineId>
        <Question>String</Question>
      </LineQuestion>
    </Questions>
    <RequireUpload>false</RequireUpload>
    <SendQuestionnaire>false</SendQuestionnaire>
    <TotalCost>0</TotalCost>
    <TotalServiceDurationMinutes>0</TotalServiceDurationMinutes>
  </CustomerCheckinRequirements>
  <CustomerCheckins>
    <CustomerCheckinObject>
      <AdjustedSignInTime>0001-01-01T00:00:00</AdjustedSignInTime>
      <Completed>false</Completed>
      <CompletedTime>0001-01-01T00:00:00</CompletedTime>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <LineId>00000000-0000-0000-0000-000000000000</LineId>
      <LineIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </LineIds>
      <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
      <QuestionnaireSubmitted>false</QuestionnaireSubmitted>
      <SendReminders>false</SendReminders>
      <SignInTime>0001-01-01T00:00:00</SignInTime>
      <StationId>00000000-0000-0000-0000-000000000000</StationId>
      <Status>0</Status>
      <TaskTime>0</TaskTime>
    </CustomerCheckinObject>
  </CustomerCheckins>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CustomerCheckinsResponse>