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}

export class CustomerCheckinObject
{
    public Id: string;
    public LineId: string;
    public CustomerId: string;
    public EmployeeId: string;
    public LocationId: string;
    public StationId: string;
    public SignInTime: string;
    public AdjustedSignInTime: string;
    public SendReminders: boolean;
    public Status: number;
    public TaskTime: number;
    public Completed: boolean;
    public CompletedTime: string;
    public QuestionnaireSubmitted: boolean;
    public LineIds: string[] = [];

    public constructor(init?: Partial<CustomerCheckinObject>) { (Object as any).assign(this, init); }
}

export class LineQuestion
{
    public Id: number;
    public CustomerCheckInId: string;
    public LineId: string;
    public Question: string;
    public Answer: string;
    public Active: boolean;

    public constructor(init?: Partial<LineQuestion>) { (Object as any).assign(this, init); }
}

export class LineImage
{
    public ImageId?: string;
    public FileName: string;
    public ImageTitle: string;
    public UploadDate: string;

    public constructor(init?: Partial<LineImage>) { (Object as any).assign(this, init); }
}

export class Line
{
    public Id: string;
    public LocationId: string;
    public LocationName: string;
    public Name: string;
    public Description: string;
    public ServiceDurationMinutes: number;
    public WaitTime: number;
    public Cost: number;
    public UpperThreshold?: number;
    public LowerThreshold?: number;
    public Active: boolean;
    public EntDate?: string;
    public ModDate?: string;
    public SendQuestionnaire: boolean;
    public RequireUpload: boolean;
    public UploadMessage: string;
    public LineImages: LineImage[] = [];

    public constructor(init?: Partial<Line>) { (Object as any).assign(this, init); }
}

export class CheckinInformation
{
    public Id: string;
    public LocationId: string;
    public LocationName: string;
    public CustomerId?: string;
    public QuestionnaireSubmitted?: boolean;
    public Name: string;
    public Description: string;
    public TotalServiceDurationMinutes: number;
    public TotalCost: number;
    public SendQuestionnaire: boolean;
    public RequireUpload: boolean;
    public Questions: LineQuestion[] = [];
    public Lines: Line[] = [];

    public constructor(init?: Partial<CheckinInformation>) { (Object as any).assign(this, init); }
}

export class CustomerCheckinsResponse
{
    public ResponseStatus: ResponseStatus;
    public CustomerCheckins: CustomerCheckinObject[] = [];
    public CustomerCheckinRequirements: CheckinInformation;

    public constructor(init?: Partial<CustomerCheckinsResponse>) { (Object as any).assign(this, init); }
}

export class CustomerCheckinsRequest extends CustomerCheckinObject
{

    public constructor(init?: Partial<CustomerCheckinsRequest>) { super(init); (Object as any).assign(this, init); }
}

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

<CustomerCheckinsRequest 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>
</CustomerCheckinsRequest>

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>