Trendsic Platform Service

<back to all web services

CustomerCheckinsPut

The following routes are available for this service:
PUT/v1/CustomerCheckins
"use strict";
export class CustomerCheckinsPutResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Success?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {boolean} */
    Success;
}
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 CustomerCheckinsPut {
    /** @param {{ApiKey?:string,Checkins?:CustomerCheckinObject[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ApiKey;
    /** @type {CustomerCheckinObject[]} */
    Checkins = [];
}

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

PUT /v1/CustomerCheckins HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerCheckinsPut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
  <Checkins>
    <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>
  </Checkins>
</CustomerCheckinsPut>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerCheckinsPutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Success>false</Success>
</CustomerCheckinsPutResponse>