Trendsic Platform Service

<back to all web services

JobEquipmentRequest

The following routes are available for this service:
PUT,OPTIONS/v1/Job/equipment
import Foundation
import ServiceStack

public class JobEquipmentRequest : Codable
{
    public var projectID:Int
    public var jobID:Int
    public var equipmentID:Int
    public var addRemove:Int

    required public init(){}
}

public class JobResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var job:[Job] = []
    public var requiresConfirm:Bool

    required public init(){}
}

public class Job : Codable
{
    public var jobID:Int
    public var jobName: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] = []

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

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

PUT /v1/Job/equipment HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ProjectID":0,"JobID":0,"EquipmentID":0,"AddRemove":0}

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"}},"Job":[{"JobID":0,"JobName":"String","JobTypeID":0,"ExpectedStartDate":"0001-01-01T00:00:00.0000000","ActualStartDate":"0001-01-01T00:00:00.0000000","ExpectedCompletionDate":"0001-01-01T00:00:00.0000000","ActualEndDate":"0001-01-01T00:00:00.0000000","Active":false,"CreatedByUID":"00000000000000000000000000000000","ProjectID":0,"StatusId":0,"AdvancedScheduling":false,"ShowTimes":false,"Schedule":[{"CalendarEventId":0,"CalendarId":"00000000000000000000000000000000","EventStart":"0001-01-01T00:00:00.0000000","EventEnd":"0001-01-01T00:00:00.0000000","Location":"String","Summary":"String","Description":"String","EventTypeId":0,"Recurrence":false,"RecurrenceFrequency":"String","RecurrenceBy":"String","RecurrenceByValue":"String","RecurrenceUntil":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CreatedByName":"String","DateCreated":"0001-01-01T00:00:00.0000000","ModifiedBy":"String","DateModified":"0001-01-01T00:00:00.0000000","Deleted":false,"TimeZone":"String","Offset":0,"TextReminderSentDate":"0001-01-01T00:00:00.0000000","Confirmed":false,"ConfirmationTextId":"String","FirstTextReminderId":"String","SecondTextReminderId":"String","LocationUID":"00000000000000000000000000000000","AgentReminderSentDate":"0001-01-01T00:00:00.0000000","ContactId":0,"IsPrivate":false,"ProjectID":0,"JobID":0,"ProjectStartDate":"0001-01-01T00:00:00.0000000","ProjectEndDate":"0001-01-01T00:00:00.0000000","MaxCrewEndDate":"0001-01-01T00:00:00.0000000","MaxEquipmentEndDate":"0001-01-01T00:00:00.0000000","CheckInId":"00000000000000000000000000000000","AllDay":false,"JobName":"String","JobStatusName":"String","JobStatusId":0,"ProjectName":"String","ResourceId":0,"ResourceName":"String","Original_EventStart":"0001-01-01T00:00:00.0000000","Original_Recurrence":false,"Original_RecurrenceFrequency":"String","Original_RecurrenceBy":"String","Original_RecurrenceByValue":"String","Original_RecurrenceUntil":"0001-01-01T00:00:00.0000000","Checksum":"String"}]}],"RequiresConfirm":false}