Trendsic Platform Service

<back to all web services

EquipmentProjectJobsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Project/{ProjectID}/equipment/{EquipmentID}/Jobs
import Foundation
import ServiceStack

public class EquipmentProjectJobsRequest : Codable
{
    public var projectID:Int
    public var equipmentID:Int

    required public init(){}
}

public class EquipmentProjectJobsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var jobs:[Job] = []

    required public init(){}
}

public class Job : Codable
{
    public var jobID:Int
    public var jobName:String
    public var Description:String
    public var jobTypeID:Int
    public var expectedStartDate:Date
    public var actualStartDate:Date
    public var expectedCompletionDate:Date
    public var actualEndDate:Date
    public var active:Bool
    public var createdByUID:String
    public var projectID:Int
    public var statusId:Int
    public var advancedScheduling:Bool
    public var showTimes:Bool
    public var schedule:[CalendarEvent] = []
    public var hasScheduledWorkers:Bool
    public var hasScheduledPlaceholders:Bool
    public var clientApprovalStatus:String
    public var internalCost:Double
    public var costToClient:Double
    public var location:Location
    public var projectLocationID:Int?
    public var projectLocationAreaID:Int?
    public var projectLocationName:String
    public var projectLocationAddress1:String
    public var projectLocationAddress2:String
    public var projectLocationCity:String
    public var projectLocationState:String
    public var projectLocationZip:String
    public var projectLocationAreaName:String

    required public init(){}
}

public class CalendarEvent : Codable
{
    public var calendarEventId:Int
    public var calendarId:String
    public var eventStart:Date
    public var eventEnd:Date
    public var location:String
    public var summary:String
    public var Description:String
    public var eventTypeId:Int
    public var recurrence:Bool
    public var recurrenceFrequency:String
    public var recurrenceBy:String
    public var recurrenceByValue:String
    public var recurrenceUntil:Date
    public var createdBy:String
    public var createdByName:String
    public var dateCreated:Date
    public var modifiedBy:String
    public var dateModified:Date
    public var deleted:Bool
    public var timeZone:String
    public var offset:Int
    public var textReminderSentDate:Date
    public var confirmed:Bool
    public var confirmationTextId:String
    public var firstTextReminderId:String
    public var secondTextReminderId:String
    public var locationUID:String?
    public var agentReminderSentDate:Date
    public var contactId:Int
    public var isPrivate:Bool
    public var projectID:Int
    public var jobID:Int
    public var projectStartDate:Date
    public var projectEndDate:Date
    public var maxCrewEndDate:Date
    public var maxEquipmentEndDate:Date
    public var checkInId:String
    public var allDay:Bool
    public var jobName:String
    public var jobStatusName:String
    public var jobStatusId:Int
    public var projectName:String
    public var resourceId:Int
    public var resourceName:String
    public var original_EventStart:Date
    public var original_Recurrence:Bool
    public var original_RecurrenceFrequency:String
    public var original_RecurrenceBy:String
    public var original_RecurrenceByValue:String
    public var original_RecurrenceUntil:Date
    public var checksum:String

    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(){}
}

Swift EquipmentProjectJobsRequest 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.

GET /v1/Project/{ProjectID}/equipment/{EquipmentID}/Jobs HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EquipmentProjectJobsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Jobs>
    <Job>
      <Active>false</Active>
      <ActualEndDate>0001-01-01T00:00:00</ActualEndDate>
      <ActualStartDate>0001-01-01T00:00:00</ActualStartDate>
      <AdvancedScheduling>false</AdvancedScheduling>
      <ClientApprovalStatus>String</ClientApprovalStatus>
      <CostToClient>0</CostToClient>
      <CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
      <Description>String</Description>
      <ExpectedCompletionDate>0001-01-01T00:00:00</ExpectedCompletionDate>
      <ExpectedStartDate>0001-01-01T00:00:00</ExpectedStartDate>
      <HasScheduledPlaceholders>false</HasScheduledPlaceholders>
      <HasScheduledWorkers>false</HasScheduledWorkers>
      <InternalCost>0</InternalCost>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <JobTypeID>0</JobTypeID>
      <Location>
        <Active>false</Active>
        <Address1>String</Address1>
        <Address2>String</Address2>
        <City>String</City>
        <ClientId>00000000-0000-0000-0000-000000000000</ClientId>
        <Email>String</Email>
        <EntDate>0001-01-01T00:00:00</EntDate>
        <Fax>String</Fax>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <LocationImage>String</LocationImage>
        <ModDate>0001-01-01T00:00:00</ModDate>
        <Name>String</Name>
        <Phone>String</Phone>
        <State>String</State>
        <TimeZone>String</TimeZone>
        <URL>String</URL>
        <Zip>String</Zip>
      </Location>
      <ProjectID>0</ProjectID>
      <ProjectLocationAddress1>String</ProjectLocationAddress1>
      <ProjectLocationAddress2>String</ProjectLocationAddress2>
      <ProjectLocationAreaID>0</ProjectLocationAreaID>
      <ProjectLocationAreaName>String</ProjectLocationAreaName>
      <ProjectLocationCity>String</ProjectLocationCity>
      <ProjectLocationID>0</ProjectLocationID>
      <ProjectLocationName>String</ProjectLocationName>
      <ProjectLocationState>String</ProjectLocationState>
      <ProjectLocationZip>String</ProjectLocationZip>
      <Schedule>
        <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>
      </Schedule>
      <ShowTimes>false</ShowTimes>
      <StatusId>0</StatusId>
    </Job>
  </Jobs>
  <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>
</EquipmentProjectJobsResponse>