| GET,OPTIONS | /v1/Scheduler/Timeslot/{SchedulerUrl}/{TimeslotId}/{Checksum} |
|---|
export class SchedulerTimeslotRequest
{
public SchedulerUrl: string;
public TimeslotId: number;
public Checksum: string;
public constructor(init?: Partial<SchedulerTimeslotRequest>) { (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 SchedulerTimeslotResponse
{
public ResponseStatus: ResponseStatus;
public Timeslot: SchedulerTimeslot;
public constructor(init?: Partial<SchedulerTimeslotResponse>) { (Object as any).assign(this, init); }
}
TypeScript SchedulerTimeslotRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SchedulerTimeslotResponse 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>
<Timeslot>
<BookedIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>0</d3p1:int>
</BookedIds>
<CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
<Contact>
<Active>false</Active>
<AdditionalInformation>String</AdditionalInformation>
<AgentId>0</AgentId>
<AltPhoneLabel>String</AltPhoneLabel>
<BusinessName>String</BusinessName>
<Carriers>String</Carriers>
<CompanyAffiliation>String</CompanyAffiliation>
<ContactCategory>0</ContactCategory>
<ContactCategoryName>String</ContactCategoryName>
<ContactGUID>00000000-0000-0000-0000-000000000000</ContactGUID>
<ContactId>0</ContactId>
<ContactImage>String</ContactImage>
<ContactStatusDesc>String</ContactStatusDesc>
<ContactStatusId>0</ContactStatusId>
<ContactType>0</ContactType>
<County>String</County>
<CountyID>0</CountyID>
<DBA>String</DBA>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<Deleted>false</Deleted>
<DeletedBy>String</DeletedBy>
<DeletedDateTimeUtc>0001-01-01T00:00:00</DeletedDateTimeUtc>
<Department>String</Department>
<District>String</District>
<DistrictID>0</DistrictID>
<DoNotContact>false</DoNotContact>
<EmailPersonal>String</EmailPersonal>
<EmailWork>String</EmailWork>
<FactFinderCodeId>0</FactFinderCodeId>
<FirstName>String</FirstName>
<Flow>String</Flow>
<HasFactFinderSheet>false</HasFactFinderSheet>
<HasGiftCard>false</HasGiftCard>
<HasNBC>false</HasNBC>
<Initials>String</Initials>
<IsShared>false</IsShared>
<JobCount>0</JobCount>
<JobID>0</JobID>
<JobName>String</JobName>
<LastContact>0001-01-01T00:00:00</LastContact>
<LastName>String</LastName>
<Locked>false</Locked>
<LockedByAgentId>0</LockedByAgentId>
<LockedTimestamp>0001-01-01T00:00:00</LockedTimestamp>
<MaritalStatus>String</MaritalStatus>
<MiddleInitial>String</MiddleInitial>
<Name>String</Name>
<NumberOfDebtAccounts>0</NumberOfDebtAccounts>
<PeraContactId>0</PeraContactId>
<Phone>String</Phone>
<PhoneAlt>String</PhoneAlt>
<PhoneLabel>String</PhoneLabel>
<ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
<Rate>0</Rate>
<Role>String</Role>
<RoomNumber>String</RoomNumber>
<SMSOptIn>false</SMSOptIn>
<SSN>String</SSN>
<School>String</School>
<SchoolID>0</SchoolID>
<SourceNote>String</SourceNote>
<SourceTypeDesc>String</SourceTypeDesc>
<SourceTypeId>0</SourceTypeId>
<State>String</State>
<StateID>0</StateID>
<StateName>String</StateName>
<Tags>String</Tags>
<Title>String</Title>
<TotalDebtAmount>0</TotalDebtAmount>
<WritingAgentId>0</WritingAgentId>
<WritingAgentName>String</WritingAgentName>
<address_city>String</address_city>
<address_line1>String</address_line1>
<address_state>String</address_state>
<address_zip>String</address_zip>
</Contact>
<Day>0001-01-01T00:00:00</Day>
<Duration>0</Duration>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<SchedulerUrl>String</SchedulerUrl>
<ServiceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
</ServiceIds>
<Time>PT0S</Time>
<Unavailable>false</Unavailable>
</Timeslot>
</SchedulerTimeslotResponse>