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

export class ScheduleConfigTimeBlock
{
    public StartTime: string;
    public DayStartFriendly: string;
    public EndTime: string;
    public DayEndFriendly: string;

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

export class ScheduleConfigDay
{
    public DayName: string;
    public DayNumber?: number;
    public DayEnabled?: boolean;
    public TimeBlocks: ScheduleConfigTimeBlock[] = [];

    public constructor(init?: Partial<ScheduleConfigDay>) { (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 SchedulerConfiguration
{
    public ConfigId: number;
    public SchedulerUrl: string;
    public SchedulerName: string;
    public DefaultLocation: string;
    public DefaultSummary: string;
    public DefaultDescription: string;
    public DayStart: string;
    public DayStartFriendly: string;
    public DayEnd: string;
    public DayEndFriendly: string;
    public TimeslotDuration: number;
    public NumberOfSlots?: number;
    public LocationId: string;
    public CalendarId: string;
    public AgentId: number;
    public TimeZone: string;
    public AvailableDateTimes: ScheduleConfigDay[] = [];
    public AvailableServices: string[] = [];
    public AllServices: Line[] = [];

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

export class SchedulerConfigurationSaveRequest
{
    public Settings: SchedulerConfiguration;

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

export class SchedulerConfigurationSaveResponse
{
    public ResponseStatus: ResponseStatus;
    public Settings: SchedulerConfiguration;

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

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