Trendsic Platform Service

<back to all web services

SchedulerConfigurationSaveRequest

Requires Authentication
Required roles:Administrator, Administrator
The following routes are available for this service:
POST,PUT,OPTIONS/v1/Scheduler/Settings
"use strict";
export class ScheduleConfigTimeBlock {
    /** @param {{StartTime?:string,DayStartFriendly?:string,EndTime?:string,DayEndFriendly?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StartTime;
    /** @type {string} */
    DayStartFriendly;
    /** @type {string} */
    EndTime;
    /** @type {string} */
    DayEndFriendly;
}
export class ScheduleConfigDay {
    /** @param {{DayName?:string,DayNumber?:number,DayEnabled?:boolean,TimeBlocks?:ScheduleConfigTimeBlock[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DayName;
    /** @type {?number} */
    DayNumber;
    /** @type {?boolean} */
    DayEnabled;
    /** @type {ScheduleConfigTimeBlock[]} */
    TimeBlocks = [];
}
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 SchedulerConfiguration {
    /** @param {{ConfigId?:number,SchedulerUrl?:string,SchedulerName?:string,DefaultLocation?:string,DefaultSummary?:string,DefaultDescription?:string,DayStart?:string,DayStartFriendly?:string,DayEnd?:string,DayEndFriendly?:string,TimeslotDuration?:number,NumberOfSlots?:number,LocationId?:string,CalendarId?:string,AgentId?:number,TimeZone?:string,AvailableDateTimes?:ScheduleConfigDay[],AvailableServices?:string[],AllServices?:Line[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ConfigId;
    /** @type {string} */
    SchedulerUrl;
    /** @type {string} */
    SchedulerName;
    /** @type {string} */
    DefaultLocation;
    /** @type {string} */
    DefaultSummary;
    /** @type {string} */
    DefaultDescription;
    /** @type {string} */
    DayStart;
    /** @type {string} */
    DayStartFriendly;
    /** @type {string} */
    DayEnd;
    /** @type {string} */
    DayEndFriendly;
    /** @type {number} */
    TimeslotDuration;
    /** @type {?number} */
    NumberOfSlots;
    /** @type {string} */
    LocationId;
    /** @type {string} */
    CalendarId;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    TimeZone;
    /** @type {ScheduleConfigDay[]} */
    AvailableDateTimes = [];
    /** @type {string[]} */
    AvailableServices = [];
    /** @type {Line[]} */
    AllServices = [];
}
export class SchedulerConfigurationSaveRequest {
    /** @param {{Settings?:SchedulerConfiguration}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SchedulerConfiguration} */
    Settings;
}
export class SchedulerConfigurationSaveResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Settings?:SchedulerConfiguration}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {SchedulerConfiguration} */
    Settings;
}

JavaScript SchedulerConfigurationSaveRequest 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/Scheduler/Settings HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SchedulerConfigurationSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Settings>
    <AgentId>0</AgentId>
    <AllServices>
      <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>
    </AllServices>
    <AvailableDateTimes>
      <ScheduleConfigDay>
        <DayEnabled>false</DayEnabled>
        <DayName>String</DayName>
        <DayNumber>0</DayNumber>
        <TimeBlocks>
          <ScheduleConfigTimeBlock>
            <EndTime>PT0S</EndTime>
            <StartTime>PT0S</StartTime>
          </ScheduleConfigTimeBlock>
        </TimeBlocks>
      </ScheduleConfigDay>
    </AvailableDateTimes>
    <AvailableServices xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </AvailableServices>
    <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
    <ConfigId>0</ConfigId>
    <DayEnd>PT0S</DayEnd>
    <DayStart>PT0S</DayStart>
    <DefaultDescription>String</DefaultDescription>
    <DefaultLocation>String</DefaultLocation>
    <DefaultSummary>String</DefaultSummary>
    <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
    <NumberOfSlots>0</NumberOfSlots>
    <SchedulerName>String</SchedulerName>
    <SchedulerUrl>String</SchedulerUrl>
    <TimeZone>String</TimeZone>
    <TimeslotDuration>0</TimeslotDuration>
  </Settings>
</SchedulerConfigurationSaveRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SchedulerConfigurationSaveResponse 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>
  <Settings>
    <AgentId>0</AgentId>
    <AllServices>
      <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>
    </AllServices>
    <AvailableDateTimes>
      <ScheduleConfigDay>
        <DayEnabled>false</DayEnabled>
        <DayName>String</DayName>
        <DayNumber>0</DayNumber>
        <TimeBlocks>
          <ScheduleConfigTimeBlock>
            <EndTime>PT0S</EndTime>
            <StartTime>PT0S</StartTime>
          </ScheduleConfigTimeBlock>
        </TimeBlocks>
      </ScheduleConfigDay>
    </AvailableDateTimes>
    <AvailableServices xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </AvailableServices>
    <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
    <ConfigId>0</ConfigId>
    <DayEnd>PT0S</DayEnd>
    <DayStart>PT0S</DayStart>
    <DefaultDescription>String</DefaultDescription>
    <DefaultLocation>String</DefaultLocation>
    <DefaultSummary>String</DefaultSummary>
    <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
    <NumberOfSlots>0</NumberOfSlots>
    <SchedulerName>String</SchedulerName>
    <SchedulerUrl>String</SchedulerUrl>
    <TimeZone>String</TimeZone>
    <TimeslotDuration>0</TimeslotDuration>
  </Settings>
</SchedulerConfigurationSaveResponse>