| GET,OPTIONS | /v1/Scheduler/{SchedulerUrl} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/Scheduler/{SchedulerUrl}/{StartDate} | ||
| GET,OPTIONS | /v1/Scheduler/{SchedulerUrl}/{StartDate}/{LocalDate} | ||
| GET,OPTIONS | /v1/SchedulerServices/{SchedulerUrl}/{StartDate}/{ServiceIdsList} |
export class SchedulerRequest
{
public SchedulerUrl: string;
public StartDate: string;
public Session: string[] = [];
public ServiceIdsList: string;
public constructor(init?: Partial<SchedulerRequest>) { (Object as any).assign(this, init); }
}
export class Location
{
public Id: string;
public ClientId: string;
public Name: string;
public Address1: string;
public Address2: string;
public City: string;
public State: string;
public Zip: string;
public Phone: string;
public Fax: string;
public URL: string;
public Email: string;
public TimeZone: string;
public Active: boolean;
public EntDate: string;
public ModDate: string;
public LocationImage: string;
public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}
export class QueueDefault
{
public LocationId: string;
public Services: string[] = [];
public constructor(init?: Partial<QueueDefault>) { (Object as any).assign(this, init); }
}
export class Agent
{
public AgentId: number;
public Company: string;
public AgentName: string;
public FirstName: string;
public LastName: string;
public MiddleInitial: string;
public Address1: string;
public Address2: string;
public City: string;
public State: string;
public Zip: string;
public Country: string;
public Email: string;
public EmailSignature: string;
public HomePhone: string;
public CellPhone: string;
public WorkPhone: string;
public InsLicensed: boolean;
public AgreeToDisclosures: boolean;
public AgreeToDate?: string;
public PaidDate?: string;
public AgentNumber: string;
public ReferringAgent: string;
public PlacementAgent: string;
public CreatedDate?: string;
public UserId: string;
public IsAgent: boolean;
public Package: string;
public StoreName: string;
public Notes: string;
public Upline1?: number;
public Upline2?: number;
public Upline3?: number;
public Upline4?: number;
public MVPID?: number;
public AVPID?: number;
public RVPID?: number;
public AgentLevel?: number;
public IsMVP: boolean;
public IsRVP: boolean;
public IsAVP: boolean;
public IsAdmin: boolean;
public IsBusinessCardAdmin: boolean;
public TeamName: string;
public LocationId: string;
public CalendarId: string;
public Rank: string;
public NBC: boolean;
public Upline1Percent?: number;
public Upline2Percent?: number;
public Upline3Percent?: number;
public Upline4Percent?: number;
public AgentStatus: string;
public Office: string;
public DOB?: string;
public SSN: string;
public Fax: string;
public BusinessEmail: string;
public ModifiedDate?: string;
public ModifiedBy: string;
public TimeZone: string;
public LeaderLocked: boolean;
public LastSubmittedBusinessDate: string;
public GracePeriodDate: string;
public Vested: boolean;
public DirectPay: string;
public DirectPayApprBy: string;
public FactFinderBilling?: number;
public FullName: string;
public ByLastName: string;
public IsSecurityLicensed: boolean;
public IsEncompassAdmin: boolean;
public ApiKey: string;
public LastSessionId: string;
public LastLogin?: string;
public MfaActive: boolean;
public RequireMFA: boolean;
public SMSPhoneNumber: string;
public VerifiedEmailStatus: boolean;
public VerifiedCellPhoneStatus: boolean;
public SchedulerUrl: string;
public QueueDefaults: QueueDefault;
public Roles: string[] = [];
public PasswordUpdated: boolean;
public RestrictToSingleSession: boolean;
public AgentImage: string;
public constructor(init?: Partial<Agent>) { (Object as any).assign(this, init); }
}
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 LineId?: string;
public ImageTitle: string;
public UploadDate: string;
public MimeType: string;
public FileName: 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 Contact
{
public ContactId: number;
public ContactType: number;
public FirstName: string;
public LastName: string;
public Name: string;
public Role: string;
public Title: string;
public EmailWork: string;
public EmailPersonal: string;
public District: string;
public DistrictID: number;
public School: string;
public SchoolID: number;
public State: string;
public StateName: string;
public StateID: number;
public CountyID: number;
public County: string;
public Phone: string;
public Department: string;
public Flow: string;
public LastContact: string;
public DoNotContact: boolean;
public Active: boolean;
public AgentId: number;
public PhoneAlt: string;
public PeraContactId: number;
public RoomNumber: string;
public SourceTypeId: number;
public SourceTypeDesc: string;
public SourceNote: string;
public ContactStatusId: number;
public ContactStatusDesc: string;
public SSN: string;
public DateOfBirth: string;
public Deleted: boolean;
public IsShared: boolean;
public address_line1: string;
public address_city: string;
public address_state: string;
public address_zip: string;
public DeletedBy: string;
public DeletedDateTimeUtc?: string;
public HasNBC: boolean;
public HasFactFinderSheet: boolean;
public MiddleInitial: string;
public Tags: string;
public DateCreated: string;
public PhoneLabel: string;
public AltPhoneLabel: string;
public Carriers: string;
public ContactImage: string;
public CompanyAffiliation: string;
public AdditionalInformation: string;
public HasGiftCard: boolean;
public ContactCategory: number;
public WritingAgentId: number;
public WritingAgentName: string;
public MaritalStatus: string;
public TotalDebtAmount: number;
public NumberOfDebtAccounts: number;
public FactFinderCodeId: number;
public BusinessName: string;
public DBA: string;
public ContactGUID: string;
public ProjectEndDate: string;
public Rate: number;
public JobID: number;
public JobName: string;
public JobCount: number;
public Locked: boolean;
public LockedByAgentId: number;
public LockedTimestamp: string;
public Initials: string;
public ContactCategoryName: string;
public SMSOptIn: boolean;
public constructor(init?: Partial<Contact>) { (Object as any).assign(this, init); }
}
export class SchedulerTimeslot
{
public Day: string;
public Time: string;
public Duration: number;
public StartDateTime: string;
public EndDateTime: string;
public TimeFriendly: string;
public Contact: Contact;
public ServiceIds: string[] = [];
public LocationId: string;
public Unavailable: boolean;
public BookedIds: number[] = [];
public CalendarId: string;
public SchedulerUrl: string;
public constructor(init?: Partial<SchedulerTimeslot>) { (Object as any).assign(this, init); }
}
export class SchedulerDay
{
public Day: string;
public MonthNumber: number;
public DayNumber: number;
public DayOfWeek: string;
public Timeslots: SchedulerTimeslot[] = [];
public constructor(init?: Partial<SchedulerDay>) { (Object as any).assign(this, init); }
}
export class SchedulerWeek
{
public Settings: SchedulerConfiguration;
public Days: SchedulerDay[] = [];
public constructor(init?: Partial<SchedulerWeek>) { (Object as any).assign(this, init); }
}
export class SchedulerResponse
{
public Location: Location;
public Agent: Agent;
public ResponseStatus: ResponseStatus;
public Week: SchedulerWeek;
public Services: Line[] = [];
public constructor(init?: Partial<SchedulerResponse>) { (Object as any).assign(this, init); }
}
TypeScript SchedulerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/Scheduler/{SchedulerUrl} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Location":{"Id":"00000000000000000000000000000000","ClientId":"00000000000000000000000000000000","Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Fax":"String","URL":"String","Email":"String","TimeZone":"String","Active":false,"EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000","LocationImage":"String"},"Agent":{"AgentId":0,"Company":"String","AgentName":"String","FirstName":"String","LastName":"String","MiddleInitial":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","Email":"String","EmailSignature":"String","HomePhone":"String","CellPhone":"String","WorkPhone":"String","InsLicensed":false,"AgreeToDisclosures":false,"AgreeToDate":"0001-01-01T00:00:00.0000000","PaidDate":"0001-01-01T00:00:00.0000000","AgentNumber":"String","ReferringAgent":"String","PlacementAgent":"String","CreatedDate":"0001-01-01T00:00:00.0000000","UserId":"00000000000000000000000000000000","IsAgent":false,"Package":"String","StoreName":"String","Notes":"String","Upline1":0,"Upline2":0,"Upline3":0,"Upline4":0,"MVPID":0,"AVPID":0,"RVPID":0,"AgentLevel":0,"IsMVP":false,"IsRVP":false,"IsAVP":false,"IsAdmin":false,"IsBusinessCardAdmin":false,"TeamName":"String","LocationId":"00000000000000000000000000000000","CalendarId":"00000000000000000000000000000000","Rank":"String","NBC":false,"Upline1Percent":0,"Upline2Percent":0,"Upline3Percent":0,"Upline4Percent":0,"AgentStatus":"String","Office":"String","DOB":"0001-01-01T00:00:00.0000000","SSN":"String","Fax":"String","BusinessEmail":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","ModifiedBy":"String","TimeZone":"String","LeaderLocked":false,"LastSubmittedBusinessDate":"0001-01-01T00:00:00.0000000","GracePeriodDate":"0001-01-01T00:00:00.0000000","Vested":false,"DirectPay":"0001-01-01T00:00:00.0000000","DirectPayApprBy":"String","FactFinderBilling":0,"FullName":"String","ByLastName":"String","IsSecurityLicensed":false,"IsEncompassAdmin":false,"ApiKey":"00000000000000000000000000000000","LastSessionId":"String","LastLogin":"0001-01-01T00:00:00.0000000","MfaActive":false,"RequireMFA":false,"SMSPhoneNumber":"String","VerifiedEmailStatus":false,"VerifiedCellPhoneStatus":false,"SchedulerUrl":"String","QueueDefaults":{"LocationId":"00000000000000000000000000000000","Services":["00000000000000000000000000000000"]},"Roles":["String"],"PasswordUpdated":false,"RestrictToSingleSession":false,"AgentImage":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Week":{"Settings":{"ConfigId":0,"SchedulerUrl":"String","SchedulerName":"String","DefaultLocation":"String","DefaultSummary":"String","DefaultDescription":"String","DayStart":"PT0S","DayStartFriendly":"00:00","DayEnd":"PT0S","DayEndFriendly":"00:00","TimeslotDuration":0,"NumberOfSlots":0,"LocationId":"00000000000000000000000000000000","CalendarId":"00000000000000000000000000000000","AgentId":0,"TimeZone":"String","AvailableDateTimes":[{"DayName":"String","DayNumber":0,"DayEnabled":false,"TimeBlocks":[{"StartTime":"PT0S","DayStartFriendly":"00:00","EndTime":"PT0S","DayEndFriendly":"00:00"}]}],"AvailableServices":["00000000000000000000000000000000"],"AllServices":[{"Id":"00000000000000000000000000000000","LocationId":"00000000000000000000000000000000","LocationName":"String","Name":"String","Description":"String","ServiceDurationMinutes":0,"WaitTime":0,"Cost":0,"UpperThreshold":0,"LowerThreshold":0,"Active":false,"EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000","SendQuestionnaire":false,"RequireUpload":false,"UploadMessage":"String","LineImages":[{"ImageId":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","ImageTitle":"String","UploadDate":"0001-01-01T00:00:00.0000000","MimeType":"String","FileName":"String"}]}]},"Days":[{}]},"Services":[{"Id":"00000000000000000000000000000000","LocationId":"00000000000000000000000000000000","LocationName":"String","Name":"String","Description":"String","ServiceDurationMinutes":0,"WaitTime":0,"Cost":0,"UpperThreshold":0,"LowerThreshold":0,"Active":false,"EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000","SendQuestionnaire":false,"RequireUpload":false,"UploadMessage":"String","LineImages":[{"ImageId":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","ImageTitle":"String","UploadDate":"0001-01-01T00:00:00.0000000","MimeType":"String","FileName":"String"}]}]}