Trendsic Platform Service

CustomerCheckinsRequest

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

"use strict";
export class CustomerCheckinObject {
    /** @param {{Id?:string,LineId?:string,CustomerId?:string,EmployeeId?:string,LocationId?:string,StationId?:string,SignInTime?:string,AdjustedSignInTime?:string,SendReminders?:boolean,Status?:number,TaskTime?:number,Completed?:boolean,CompletedTime?:string,QuestionnaireSubmitted?:boolean,LineIds?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    LineId;
    /** @type {string} */
    CustomerId;
    /** @type {string} */
    EmployeeId;
    /** @type {string} */
    LocationId;
    /** @type {string} */
    StationId;
    /** @type {string} */
    SignInTime;
    /** @type {string} */
    AdjustedSignInTime;
    /** @type {boolean} */
    SendReminders;
    /** @type {number} */
    Status;
    /** @type {number} */
    TaskTime;
    /** @type {boolean} */
    Completed;
    /** @type {string} */
    CompletedTime;
    /** @type {boolean} */
    QuestionnaireSubmitted;
    /** @type {string[]} */
    LineIds = [];
}
export class LineQuestion {
    /** @param {{Id?:number,CustomerCheckInId?:string,LineId?:string,Question?:string,Answer?:string,Active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    CustomerCheckInId;
    /** @type {string} */
    LineId;
    /** @type {string} */
    Question;
    /** @type {string} */
    Answer;
    /** @type {boolean} */
    Active;
}
export class LineImage {
    /** @param {{ImageId?:string,FileName?:string,ImageTitle?:string,UploadDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    ImageId;
    /** @type {string} */
    FileName;
    /** @type {string} */
    ImageTitle;
    /** @type {string} */
    UploadDate;
}
export class Line {
    /** @param {{Id?:string,LocationId?:string,LocationName?:string,Name?:string,Description?:string,ServiceDurationMinutes?:number,WaitTime?:number,Cost?:number,UpperThreshold?:number,LowerThreshold?:number,Active?:boolean,EntDate?:string,ModDate?:string,SendQuestionnaire?:boolean,RequireUpload?:boolean,UploadMessage?:string,LineImages?:LineImage[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    LocationId;
    /** @type {string} */
    LocationName;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {number} */
    ServiceDurationMinutes;
    /** @type {number} */
    WaitTime;
    /** @type {number} */
    Cost;
    /** @type {?number} */
    UpperThreshold;
    /** @type {?number} */
    LowerThreshold;
    /** @type {boolean} */
    Active;
    /** @type {?string} */
    EntDate;
    /** @type {?string} */
    ModDate;
    /** @type {boolean} */
    SendQuestionnaire;
    /** @type {boolean} */
    RequireUpload;
    /** @type {string} */
    UploadMessage;
    /** @type {LineImage[]} */
    LineImages = [];
}
export class CheckinInformation {
    /** @param {{Id?:string,LocationId?:string,LocationName?:string,CustomerId?:string,QuestionnaireSubmitted?:boolean,Name?:string,Description?:string,TotalServiceDurationMinutes?:number,TotalCost?:number,SendQuestionnaire?:boolean,RequireUpload?:boolean,Questions?:LineQuestion[],Lines?:Line[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    LocationId;
    /** @type {string} */
    LocationName;
    /** @type {?string} */
    CustomerId;
    /** @type {?boolean} */
    QuestionnaireSubmitted;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {number} */
    TotalServiceDurationMinutes;
    /** @type {number} */
    TotalCost;
    /** @type {boolean} */
    SendQuestionnaire;
    /** @type {boolean} */
    RequireUpload;
    /** @type {LineQuestion[]} */
    Questions = [];
    /** @type {Line[]} */
    Lines = [];
}
export class CustomerCheckinsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,CustomerCheckins?:CustomerCheckinObject[],CustomerCheckinRequirements?:CheckinInformation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CustomerCheckinObject[]} */
    CustomerCheckins = [];
    /** @type {CheckinInformation} */
    CustomerCheckinRequirements;
}
export class CustomerCheckinsRequest extends CustomerCheckinObject {
    /** @param {{Id?:string,LineId?:string,CustomerId?:string,EmployeeId?:string,LocationId?:string,StationId?:string,SignInTime?:string,AdjustedSignInTime?:string,SendReminders?:boolean,Status?:number,TaskTime?:number,Completed?:boolean,CompletedTime?:string,QuestionnaireSubmitted?:boolean,LineIds?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript 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>