| 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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class SchedulerRequest
{
open var SchedulerUrl:String? = null
open var StartDate:Date? = null
open var Session:ArrayList<String> = ArrayList<String>()
open var ServiceIdsList:String? = null
}
open class SchedulerResponse
{
open var ResponseStatus:ResponseStatus? = null
open var Week:SchedulerWeek? = null
open var Services:ArrayList<Line> = ArrayList<Line>()
}
open class SchedulerWeek
{
open var Settings:SchedulerConfiguration? = null
open var Days:ArrayList<SchedulerDay> = ArrayList<SchedulerDay>()
}
open class SchedulerConfiguration
{
open var ConfigId:Int? = null
open var SchedulerUrl:String? = null
open var SchedulerName:String? = null
open var DefaultLocation:String? = null
open var DefaultSummary:String? = null
open var DefaultDescription:String? = null
open var DayStart:TimeSpan? = null
open var DayStartFriendly:String? = null
open var DayEnd:TimeSpan? = null
open var DayEndFriendly:String? = null
open var TimeslotDuration:Int? = null
open var NumberOfSlots:Int? = null
open var LocationId:UUID? = null
open var CalendarId:UUID? = null
open var AgentId:Int? = null
open var TimeZone:String? = null
open var AvailableDateTimes:ArrayList<ScheduleConfigDay> = ArrayList<ScheduleConfigDay>()
open var AvailableServices:ArrayList<UUID> = ArrayList<UUID>()
open var AllServices:ArrayList<Line> = ArrayList<Line>()
}
open class ScheduleConfigDay
{
open var DayName:String? = null
open var DayNumber:Int? = null
open var DayEnabled:Boolean? = null
open var TimeBlocks:ArrayList<ScheduleConfigTimeBlock> = ArrayList<ScheduleConfigTimeBlock>()
}
open class ScheduleConfigTimeBlock
{
open var StartTime:TimeSpan? = null
open var DayStartFriendly:String? = null
open var EndTime:TimeSpan? = null
open var DayEndFriendly:String? = null
}
open class Line
{
open var Id:UUID? = null
open var LocationId:UUID? = null
open var LocationName:String? = null
open var Name:String? = null
open var Description:String? = null
open var ServiceDurationMinutes:Int? = null
open var WaitTime:Int? = null
open var Cost:BigDecimal? = null
open var UpperThreshold:Int? = null
open var LowerThreshold:Int? = null
open var Active:Boolean? = null
open var EntDate:Date? = null
open var ModDate:Date? = null
open var SendQuestionnaire:Boolean? = null
open var RequireUpload:Boolean? = null
open var UploadMessage:String? = null
open var LineImages:ArrayList<LineImage> = ArrayList<LineImage>()
}
open class LineImage
{
open var ImageId:UUID? = null
open var FileName:String? = null
open var ImageTitle:String? = null
open var UploadDate:Date? = null
}
open class SchedulerDay
{
open var Day:Date? = null
open var MonthNumber:Int? = null
open var DayNumber:Int? = null
open var DayOfWeek:String? = null
open var Timeslots:ArrayList<SchedulerTimeslot> = ArrayList<SchedulerTimeslot>()
}
open class SchedulerTimeslot
{
open var Day:Date? = null
open var Time:TimeSpan? = null
open var Duration:Int? = null
open var StartDateTime:Date? = null
open var EndDateTime:Date? = null
open var TimeFriendly:String? = null
open var Contact:Contact? = null
open var ServiceIds:ArrayList<UUID> = ArrayList<UUID>()
open var LocationId:UUID? = null
open var Unavailable:Boolean? = null
open var BookedIds:ArrayList<Int> = ArrayList<Int>()
open var CalendarId:UUID? = null
open var SchedulerUrl:String? = null
}
open class Contact
{
open var ContactId:Int? = null
open var ContactType:Int? = null
open var FirstName:String? = null
open var LastName:String? = null
open var Name:String? = null
open var Role:String? = null
open var Title:String? = null
open var EmailWork:String? = null
open var EmailPersonal:String? = null
open var District:String? = null
open var DistrictID:Int? = null
open var School:String? = null
open var SchoolID:Long? = null
open var State:String? = null
open var StateName:String? = null
open var StateID:Long? = null
open var CountyID:Long? = null
open var County:String? = null
open var Phone:String? = null
open var Department:String? = null
open var Flow:String? = null
open var LastContact:Date? = null
open var DoNotContact:Boolean? = null
open var Active:Boolean? = null
open var AgentId:Int? = null
open var PhoneAlt:String? = null
open var PeraContactId:Int? = null
open var RoomNumber:String? = null
open var SourceTypeId:Int? = null
open var SourceTypeDesc:String? = null
open var SourceNote:String? = null
open var ContactStatusId:Int? = null
open var ContactStatusDesc:String? = null
open var SSN:String? = null
open var DateOfBirth:Date? = null
open var Deleted:Boolean? = null
open var IsShared:Boolean? = null
open var address_line1:String? = null
open var address_city:String? = null
open var address_state:String? = null
open var address_zip:String? = null
open var DeletedBy:String? = null
open var DeletedDateTimeUtc:Date? = null
open var HasNBC:Boolean? = null
open var HasFactFinderSheet:Boolean? = null
open var MiddleInitial:String? = null
open var Tags:String? = null
open var DateCreated:Date? = null
open var PhoneLabel:String? = null
open var AltPhoneLabel:String? = null
open var Carriers:String? = null
open var ContactImage:String? = null
open var CompanyAffiliation:String? = null
open var AdditionalInformation:String? = null
open var HasGiftCard:Boolean? = null
open var ContactCategory:Int? = null
open var WritingAgentId:Int? = null
open var WritingAgentName:String? = null
open var MaritalStatus:String? = null
open var TotalDebtAmount:BigDecimal? = null
open var NumberOfDebtAccounts:Int? = null
open var FactFinderCodeId:Int? = null
open var BusinessName:String? = null
open var DBA:String? = null
open var ContactGUID:UUID? = null
open var ProjectEndDate:Date? = null
open var Rate:Int? = null
open var JobID:Int? = null
open var JobName:String? = null
open var JobCount:Int? = null
open var Locked:Boolean? = null
open var LockedByAgentId:Int? = null
open var LockedTimestamp:Date? = null
open var Initials:String? = null
open var ContactCategoryName:String? = null
open var SMSOptIn:Boolean? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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-01,
ModDate: 0001-01-01,
SendQuestionnaire: False,
RequireUpload: False,
UploadMessage: String,
LineImages:
[
{
ImageId: 00000000000000000000000000000000,
FileName: String,
ImageTitle: String,
UploadDate: 0001-01-01
}
]
}
]
},
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-01,
ModDate: 0001-01-01,
SendQuestionnaire: False,
RequireUpload: False,
UploadMessage: String,
LineImages:
[
{
ImageId: 00000000000000000000000000000000,
FileName: String,
ImageTitle: String,
UploadDate: 0001-01-01
}
]
}
]
}