Trendsic Platform Service

<back to all web services

SchedulerTimeslotRequest

The following routes are available for this service:
GET,OPTIONS/v1/Scheduler/Timeslot/{SchedulerUrl}/{TimeslotId}/{Checksum}
import Foundation
import ServiceStack

public class SchedulerTimeslotRequest : Codable
{
    public var schedulerUrl:String
    public var timeslotId:Int
    public var checksum:String

    required public init(){}
}

public class SchedulerTimeslotResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var timeslot: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 SchedulerTimeslotRequest 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/Timeslot/{SchedulerUrl}/{TimeslotId}/{Checksum} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Timeslot":{"Day":"0001-01-01T00:00:00.0000000","Time":"PT0S","Duration":0,"StartDateTime":"0001-01-01T00:00:00.0000000","EndDateTime":"0001-01-01T00:00:00.0000000","TimeFriendly":"12:00 am","Contact":{"ContactId":0,"ContactType":0,"FirstName":"String","LastName":"String","Name":"String","Role":"String","Title":"String","EmailWork":"String","EmailPersonal":"String","District":"String","DistrictID":0,"School":"String","SchoolID":0,"State":"String","StateName":"String","StateID":0,"CountyID":0,"County":"String","Phone":"String","Department":"String","Flow":"String","LastContact":"0001-01-01T00:00:00.0000000","DoNotContact":false,"Active":false,"AgentId":0,"PhoneAlt":"String","PeraContactId":0,"RoomNumber":"String","SourceTypeId":0,"SourceTypeDesc":"String","SourceNote":"String","ContactStatusId":0,"ContactStatusDesc":"String","SSN":"String","DateOfBirth":"0001-01-01T00:00:00.0000000","Deleted":false,"IsShared":false,"address_line1":"String","address_city":"String","address_state":"String","address_zip":"String","DeletedBy":"String","DeletedDateTimeUtc":"0001-01-01T00:00:00.0000000","HasNBC":false,"HasFactFinderSheet":false,"MiddleInitial":"String","Tags":"String","DateCreated":"0001-01-01T00:00:00.0000000","PhoneLabel":"String","AltPhoneLabel":"String","Carriers":"String","ContactImage":"String","CompanyAffiliation":"String","AdditionalInformation":"String","HasGiftCard":false,"ContactCategory":0,"WritingAgentId":0,"WritingAgentName":"String","MaritalStatus":"String","TotalDebtAmount":0,"NumberOfDebtAccounts":0,"FactFinderCodeId":0,"BusinessName":"String","DBA":"String","ContactGUID":"00000000000000000000000000000000","ProjectEndDate":"0001-01-01T00:00:00.0000000","Rate":0,"JobID":0,"JobName":"String","JobCount":0,"Locked":false,"LockedByAgentId":0,"LockedTimestamp":"0001-01-01T00:00:00.0000000","Initials":"String","ContactCategoryName":"String","SMSOptIn":false},"ServiceIds":["00000000000000000000000000000000"],"LocationId":"00000000000000000000000000000000","Unavailable":false,"BookedIds":[0],"CalendarId":"00000000000000000000000000000000","SchedulerUrl":"String"}}