Trendsic Platform Service

<back to all web services

JobScheduleRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Job/Schedule/{JobID}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class JobScheduleRequest
{
    open var JobID:Int? = null
}

open class JobScheduleResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var JobSchedule:ArrayList<CalendarEvent> = ArrayList<CalendarEvent>()
}

open class CalendarEvent
{
    open var CalendarEventId:Int? = null
    open var CalendarId:UUID? = null
    open var EventStart:Date? = null
    open var EventEnd:Date? = null
    open var Location:String? = null
    open var Summary:String? = null
    open var Description:String? = null
    open var EventTypeId:Int? = null
    open var Recurrence:Boolean? = null
    open var RecurrenceFrequency:String? = null
    open var RecurrenceBy:String? = null
    open var RecurrenceByValue:String? = null
    open var RecurrenceUntil:Date? = null
    open var CreatedBy:String? = null
    open var CreatedByName:String? = null
    open var DateCreated:Date? = null
    open var ModifiedBy:String? = null
    open var DateModified:Date? = null
    open var Deleted:Boolean? = null
    open var TimeZone:String? = null
    open var Offset:Int? = null
    open var TextReminderSentDate:Date? = null
    open var Confirmed:Boolean? = null
    open var ConfirmationTextId:String? = null
    open var FirstTextReminderId:String? = null
    open var SecondTextReminderId:String? = null
    open var LocationUID:UUID? = null
    open var AgentReminderSentDate:Date? = null
    open var ContactId:Int? = null
    open var IsPrivate:Boolean? = null
    open var ProjectID:Int? = null
    open var JobID:Int? = null
    open var ProjectStartDate:Date? = null
    open var ProjectEndDate:Date? = null
    open var MaxCrewEndDate:Date? = null
    open var MaxEquipmentEndDate:Date? = null
    open var CheckInId:UUID? = null
    open var AllDay:Boolean? = null
    open var JobName:String? = null
    open var JobStatusName:String? = null
    open var JobStatusId:Int? = null
    open var ProjectName:String? = null
    open var ResourceId:Int? = null
    open var ResourceName:String? = null
    open var Original_EventStart:Date? = null
    open var Original_Recurrence:Boolean? = null
    open var Original_RecurrenceFrequency:String? = null
    open var Original_RecurrenceBy:String? = null
    open var Original_RecurrenceByValue:String? = null
    open var Original_RecurrenceUntil:Date? = null
    open var Checksum:String? = null
}

Kotlin JobScheduleRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/Job/Schedule/{JobID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JobScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <JobID>0</JobID>
</JobScheduleRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JobScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <JobSchedule>
    <CalendarEvent>
      <AgentReminderSentDate>0001-01-01T00:00:00</AgentReminderSentDate>
      <AllDay>false</AllDay>
      <CalendarEventId>0</CalendarEventId>
      <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
      <CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
      <Checksum>String</Checksum>
      <ConfirmationTextId>String</ConfirmationTextId>
      <Confirmed>false</Confirmed>
      <ContactId>0</ContactId>
      <CreatedBy>String</CreatedBy>
      <CreatedByName>String</CreatedByName>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateModified>0001-01-01T00:00:00</DateModified>
      <Deleted>false</Deleted>
      <Description>String</Description>
      <EventEnd>0001-01-01T00:00:00</EventEnd>
      <EventStart>0001-01-01T00:00:00</EventStart>
      <EventTypeId>0</EventTypeId>
      <FirstTextReminderId>String</FirstTextReminderId>
      <IsPrivate>false</IsPrivate>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <JobStatusId>0</JobStatusId>
      <JobStatusName>String</JobStatusName>
      <Location>String</Location>
      <LocationUID>00000000-0000-0000-0000-000000000000</LocationUID>
      <MaxCrewEndDate>0001-01-01T00:00:00</MaxCrewEndDate>
      <MaxEquipmentEndDate>0001-01-01T00:00:00</MaxEquipmentEndDate>
      <ModifiedBy>String</ModifiedBy>
      <Offset>0</Offset>
      <Original_EventStart>0001-01-01T00:00:00</Original_EventStart>
      <Original_Recurrence>false</Original_Recurrence>
      <Original_RecurrenceBy>String</Original_RecurrenceBy>
      <Original_RecurrenceByValue>String</Original_RecurrenceByValue>
      <Original_RecurrenceFrequency>String</Original_RecurrenceFrequency>
      <Original_RecurrenceUntil>0001-01-01T00:00:00</Original_RecurrenceUntil>
      <ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <ProjectStartDate>0001-01-01T00:00:00</ProjectStartDate>
      <Recurrence>false</Recurrence>
      <RecurrenceBy>String</RecurrenceBy>
      <RecurrenceByValue>String</RecurrenceByValue>
      <RecurrenceFrequency>String</RecurrenceFrequency>
      <RecurrenceUntil>0001-01-01T00:00:00</RecurrenceUntil>
      <ResourceId>0</ResourceId>
      <ResourceName>String</ResourceName>
      <SecondTextReminderId>String</SecondTextReminderId>
      <Summary>String</Summary>
      <TextReminderSentDate>0001-01-01T00:00:00</TextReminderSentDate>
      <TimeZone>String</TimeZone>
    </CalendarEvent>
  </JobSchedule>
  <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>
</JobScheduleResponse>