Trendsic Platform Service

<back to all web services

SchedulerRequest

The following routes are available for this service:
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}
import Foundation
import ServiceStack

public class SchedulerRequest : Codable
{
    public var schedulerUrl:String
    public var startDate:Date
    public var session:[String] = []
    public var serviceIdsList:String

    required public init(){}
}

public class SchedulerResponse : Codable
{
    public var location:Location
    public var agent:Agent
    public var responseStatus:ResponseStatus
    public var week:SchedulerWeek
    public var services:[Line] = []

    required public init(){}
}

public class Location : Codable
{
    public var id:String
    public var clientId:String
    public var name:String
    public var address1:String
    public var address2:String
    public var city:String
    public var state:String
    public var zip:String
    public var phone:String
    public var fax:String
    public var url:String
    public var email:String
    public var timeZone:String
    public var active:Bool
    public var entDate:Date
    public var modDate:Date
    public var locationImage:String

    required public init(){}
}

public class Agent : Codable
{
    public var agentId:Int
    public var company:String
    public var agentName:String
    public var firstName:String
    public var lastName:String
    public var middleInitial:String
    public var address1:String
    public var address2:String
    public var city:String
    public var state:String
    public var zip:String
    public var country:String
    public var email:String
    public var emailSignature:String
    public var homePhone:String
    public var cellPhone:String
    public var workPhone:String
    public var insLicensed:Bool
    public var agreeToDisclosures:Bool
    public var agreeToDate:Date?
    public var paidDate:Date?
    public var agentNumber:String
    public var referringAgent:String
    public var placementAgent:String
    public var createdDate:Date?
    public var userId:String
    public var isAgent:Bool
    public var package:String
    public var storeName:String
    public var notes:String
    public var upline1:Int?
    public var upline2:Int?
    public var upline3:Int?
    public var upline4:Int?
    public var mvpid:Int?
    public var avpid:Int?
    public var rvpid:Int?
    public var agentLevel:Double?
    public var isMVP:Bool
    public var isRVP:Bool
    public var isAVP:Bool
    public var isAdmin:Bool
    public var isBusinessCardAdmin:Bool
    public var teamName:String
    public var locationId:String
    public var calendarId:String
    public var rank:String
    public var nbc:Bool
    public var upline1Percent:Double?
    public var upline2Percent:Double?
    public var upline3Percent:Double?
    public var upline4Percent:Double?
    public var agentStatus:String
    public var office:String
    public var dob:Date?
    public var ssn:String
    public var fax:String
    public var businessEmail:String
    public var modifiedDate:Date?
    public var modifiedBy:String
    public var timeZone:String
    public var leaderLocked:Bool
    public var lastSubmittedBusinessDate:Date
    public var gracePeriodDate:Date
    public var vested:Bool
    public var directPay:Date
    public var directPayApprBy:String
    public var factFinderBilling:Double?
    public var fullName:String
    public var byLastName:String
    public var isSecurityLicensed:Bool
    public var isEncompassAdmin:Bool
    public var apiKey:String
    public var lastSessionId:String
    public var lastLogin:Date?
    public var mfaActive:Bool
    public var requireMFA:Bool
    public var smsPhoneNumber:String
    public var verifiedEmailStatus:Bool
    public var verifiedCellPhoneStatus:Bool
    public var schedulerUrl:String
    public var queueDefaults:QueueDefault
    public var roles:[String] = []
    public var passwordUpdated:Bool
    public var restrictToSingleSession:Bool
    public var agentImage:String

    required public init(){}
}

public class QueueDefault : Codable
{
    public var locationId:String
    public var services:[String] = []

    required public init(){}
}

public class SchedulerWeek : Codable
{
    public var settings:SchedulerConfiguration
    public var days:[SchedulerDay] = []

    required public init(){}
}

public class SchedulerConfiguration : Codable
{
    public var configId:Int
    public var schedulerUrl:String
    public var schedulerName:String
    public var defaultLocation:String
    public var defaultSummary:String
    public var defaultDescription:String
    @TimeSpan public var dayStart:TimeInterval
    public var dayStartFriendly:String
    @TimeSpan public var dayEnd:TimeInterval
    public var dayEndFriendly:String
    public var timeslotDuration:Int
    public var numberOfSlots:Int?
    public var locationId:String
    public var calendarId:String
    public var agentId:Int
    public var timeZone:String
    public var availableDateTimes:[ScheduleConfigDay] = []
    public var availableServices:[String] = []
    public var allServices:[Line] = []

    required public init(){}
}

public class ScheduleConfigDay : Codable
{
    public var dayName:String
    public var dayNumber:Int?
    public var dayEnabled:Bool?
    public var timeBlocks:[ScheduleConfigTimeBlock] = []

    required public init(){}
}

public class ScheduleConfigTimeBlock : Codable
{
    @TimeSpan public var startTime:TimeInterval
    public var dayStartFriendly:String
    @TimeSpan public var endTime:TimeInterval
    public var dayEndFriendly:String

    required public init(){}
}

public class Line : Codable
{
    public var id:String
    public var locationId:String
    public var locationName:String
    public var name:String
    public var Description:String
    public var serviceDurationMinutes:Int
    public var waitTime:Int
    public var cost:Double
    public var upperThreshold:Int?
    public var lowerThreshold:Int?
    public var active:Bool
    public var entDate:Date?
    public var modDate:Date?
    public var sendQuestionnaire:Bool
    public var requireUpload:Bool
    public var uploadMessage:String
    public var lineImages:[LineImage] = []

    required public init(){}
}

public class LineImage : Codable
{
    public var imageId:String?
    public var lineId:String?
    public var imageTitle:String
    public var uploadDate:Date
    public var mimeType:String
    public var fileName:String

    required public init(){}
}

public class SchedulerDay : Codable
{
    public var day:Date
    public var monthNumber:Int
    public var dayNumber:Int
    public var dayOfWeek:String
    public var timeslots:[SchedulerTimeslot] = []

    required public init(){}
}

public class SchedulerTimeslot : Codable
{
    public var day:Date
    @TimeSpan public var time:TimeInterval
    public var duration:Int
    public var startDateTime:Date
    public var endDateTime:Date
    public var timeFriendly:String
    public var contact:Contact
    public var serviceIds:[String] = []
    public var locationId:String
    public var unavailable:Bool
    public var bookedIds:[Int] = []
    public var calendarId:String
    public var schedulerUrl:String

    required public init(){}
}

public class Contact : Codable
{
    public var contactId:Int
    public var contactType:Int
    public var firstName:String
    public var lastName:String
    public var name:String
    public var role:String
    public var title:String
    public var emailWork:String
    public var emailPersonal:String
    public var district:String
    public var districtID:Int
    public var school:String
    public var schoolID:Int
    public var state:String
    public var stateName:String
    public var stateID:Int
    public var countyID:Int
    public var county:String
    public var phone:String
    public var department:String
    public var flow:String
    public var lastContact:Date
    public var doNotContact:Bool
    public var active:Bool
    public var agentId:Int
    public var phoneAlt:String
    public var peraContactId:Int
    public var roomNumber:String
    public var sourceTypeId:Int
    public var sourceTypeDesc:String
    public var sourceNote:String
    public var contactStatusId:Int
    public var contactStatusDesc:String
    public var ssn:String
    public var dateOfBirth:Date
    public var deleted:Bool
    public var isShared:Bool
    public var address_line1:String
    public var address_city:String
    public var address_state:String
    public var address_zip:String
    public var deletedBy:String
    public var deletedDateTimeUtc:Date?
    public var hasNBC:Bool
    public var hasFactFinderSheet:Bool
    public var middleInitial:String
    public var tags:String
    public var dateCreated:Date
    public var phoneLabel:String
    public var altPhoneLabel:String
    public var carriers:String
    public var contactImage:String
    public var companyAffiliation:String
    public var additionalInformation:String
    public var hasGiftCard:Bool
    public var contactCategory:Int
    public var writingAgentId:Int
    public var writingAgentName:String
    public var maritalStatus:String
    public var totalDebtAmount:Double
    public var numberOfDebtAccounts:Int
    public var factFinderCodeId:Int
    public var businessName:String
    public var dba:String
    public var contactGUID:String
    public var projectEndDate:Date
    public var rate:Int
    public var jobID:Int
    public var jobName:String
    public var jobCount:Int
    public var locked:Bool
    public var lockedByAgentId:Int
    public var lockedTimestamp:Date
    public var initials:String
    public var contactCategoryName:String
    public var smsOptIn:Bool

    required public init(){}
}

Swift 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

HTTP + JSON

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"}]}]}