Trendsic Platform Service

<back to all web services

ProjectEquipmentListRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Project/Equipment/{ProjectID}
GET,POST,PUT,DELETE,OPTIONS/v1/Project/Equipment/{ProjectID}/{JobID}
import Foundation
import ServiceStack

public class ProjectEquipmentListRequest : Codable
{
    public var projectID:Int
    public var jobID:Int
    public var projectEquipment:[Equipment] = []

    required public init(){}
}

public class Equipment : Codable
{
    public var equipmentID:Int
    public var equipmentName:String
    public var equipmentTypeID:Int16
    public var manufacturer:String
    public var equipmentType:String
    public var serialNumber:String
    public var barCode:String
    public var equipmentLocation:String
    public var imageURL:String
    public var productDetailsURL:String
    public var recordCreatedDate:Date
    public var createdByUID:String
    public var active:Bool
    public var notes:String
    public var rate:Double
    public var branchId:String
    public var branchName:String
    public var ownership:String
    public var rentalVendor:String
    public var rentalStart:Date?
    public var rentalEnd:Date?
    public var projects:[Project] = []

    required public init(){}
}

public class Project : Codable
{
    public var projectID:Int
    public var projectUID:String
    public var projectName:String
    public var imageURL:String
    public var imageKey:String
    public var clientName:String
    public var clientPhone:String
    public var clientEmail:String
    public var notifyCustomerOnVisitCompletion:Bool
    public var clientContactID:Int?
    public var projectManagerID:Int
    public var projectManagerName:String
    public var startDate:Date?
    public var endDate:Date?
    public var actualStartDate:Date?
    public var actualEndDate:Date?
    public var jobCount:Int
    public var crewMemberCount:Int
    public var crewAvatarsJson:String
    public var crewNamesSearch:String
    public var equipmentCount:Int
    public var materialCount:Int
    public var projectStatusID:Int16
    public var projectStatusDescription:String
    public var budget:Double
    public var costToDate:Double
    public var projectLocation:String
    public var projectType:String
    public var projectSponsor:String
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?
    public var projectDescription:String
    public var scope:String
    public var statusId:Int
    public var branchId:String
    public var branchName:String
    public var location:Location

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

public class ProjectEquipmentListResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var projectEquipment:[ProjectEquipment] = []

    required public init(){}
}

public class ProjectEquipment : Equipment
{
    public var projectEquipmentID:Int
    public var projectID:Int
    public var projectEndDate:Date
    public var firstJobUseDate:Date
    public var lastJobUseDate:Date
    public var equipmentRate:Double
    public var jobID:Int
    public var billedEquipmentRate:Double
    public var status:String
    public var source:String
    public var overlapBookings:Int
    public var hasBookingConflict:Bool
    public var conflictJobs:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case projectEquipmentID
        case projectID
        case projectEndDate
        case firstJobUseDate
        case lastJobUseDate
        case equipmentRate
        case jobID
        case billedEquipmentRate
        case status
        case source
        case overlapBookings
        case hasBookingConflict
        case conflictJobs
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        projectEquipmentID = try container.decodeIfPresent(Int.self, forKey: .projectEquipmentID)
        projectID = try container.decodeIfPresent(Int.self, forKey: .projectID)
        projectEndDate = try container.decodeIfPresent(Date.self, forKey: .projectEndDate)
        firstJobUseDate = try container.decodeIfPresent(Date.self, forKey: .firstJobUseDate)
        lastJobUseDate = try container.decodeIfPresent(Date.self, forKey: .lastJobUseDate)
        equipmentRate = try container.decodeIfPresent(Double.self, forKey: .equipmentRate)
        jobID = try container.decodeIfPresent(Int.self, forKey: .jobID)
        billedEquipmentRate = try container.decodeIfPresent(Double.self, forKey: .billedEquipmentRate)
        status = try container.decodeIfPresent(String.self, forKey: .status)
        source = try container.decodeIfPresent(String.self, forKey: .source)
        overlapBookings = try container.decodeIfPresent(Int.self, forKey: .overlapBookings)
        hasBookingConflict = try container.decodeIfPresent(Bool.self, forKey: .hasBookingConflict)
        conflictJobs = try container.decodeIfPresent(String.self, forKey: .conflictJobs)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if projectEquipmentID != nil { try container.encode(projectEquipmentID, forKey: .projectEquipmentID) }
        if projectID != nil { try container.encode(projectID, forKey: .projectID) }
        if projectEndDate != nil { try container.encode(projectEndDate, forKey: .projectEndDate) }
        if firstJobUseDate != nil { try container.encode(firstJobUseDate, forKey: .firstJobUseDate) }
        if lastJobUseDate != nil { try container.encode(lastJobUseDate, forKey: .lastJobUseDate) }
        if equipmentRate != nil { try container.encode(equipmentRate, forKey: .equipmentRate) }
        if jobID != nil { try container.encode(jobID, forKey: .jobID) }
        if billedEquipmentRate != nil { try container.encode(billedEquipmentRate, forKey: .billedEquipmentRate) }
        if status != nil { try container.encode(status, forKey: .status) }
        if source != nil { try container.encode(source, forKey: .source) }
        if overlapBookings != nil { try container.encode(overlapBookings, forKey: .overlapBookings) }
        if hasBookingConflict != nil { try container.encode(hasBookingConflict, forKey: .hasBookingConflict) }
        if conflictJobs != nil { try container.encode(conflictJobs, forKey: .conflictJobs) }
    }
}

Swift ProjectEquipmentListRequest DTOs

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

HTTP + OTHER

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

POST /v1/Project/Equipment/{ProjectID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ProjectID":0,"JobID":0,"ProjectEquipment":[{"EquipmentID":0,"EquipmentName":"String","EquipmentTypeID":0,"Manufacturer":"String","EquipmentType":"String","SerialNumber":"String","BarCode":"String","EquipmentLocation":"String","ImageURL":"String","ProductDetailsURL":"String","RecordCreatedDate":"0001-01-01T00:00:00.0000000","CreatedByUID":"00000000000000000000000000000000","Active":false,"Notes":"String","Rate":0,"BranchId":"00000000000000000000000000000000","BranchName":"String","Ownership":"String","RentalVendor":"String","RentalStart":"0001-01-01T00:00:00.0000000","RentalEnd":"0001-01-01T00:00:00.0000000","Projects":[{"ProjectID":0,"ProjectUID":"00000000000000000000000000000000","ProjectName":"String","ImageURL":"String","ImageKey":"String","ClientName":"String","ClientPhone":"String","ClientEmail":"String","NotifyCustomerOnVisitCompletion":false,"ClientContactID":0,"ProjectManagerID":0,"ProjectManagerName":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","ActualStartDate":"0001-01-01T00:00:00.0000000","ActualEndDate":"0001-01-01T00:00:00.0000000","JobCount":0,"CrewMemberCount":0,"CrewAvatarsJson":"String","CrewNamesSearch":"String","EquipmentCount":0,"MaterialCount":0,"ProjectStatusID":0,"ProjectStatusDescription":"String","Budget":0,"CostToDate":0,"ProjectLocation":"String","ProjectType":"String","ProjectSponsor":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","ProjectDescription":"String","Scope":"String","StatusId":0,"BranchId":"00000000000000000000000000000000","BranchName":"String","Location":{"Id":"00000000000000000000000000000000","ClientId":"00000000000000000000000000000000","Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Fax":"String","URL":"String","Email":"String","TimeZone":"String","Active":false,"EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000","LocationImage":"String"}}]}]}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ProjectEquipment":[{"ProjectEquipmentID":0,"ProjectID":0,"ProjectEndDate":"0001-01-01T00:00:00.0000000","FirstJobUseDate":"0001-01-01T00:00:00.0000000","LastJobUseDate":"0001-01-01T00:00:00.0000000","EquipmentRate":0,"JobID":0,"BilledEquipmentRate":0,"Status":"String","Source":"String","OverlapBookings":0,"HasBookingConflict":false,"ConflictJobs":"String","EquipmentID":0,"EquipmentName":"String","EquipmentTypeID":0,"Manufacturer":"String","EquipmentType":"String","SerialNumber":"String","BarCode":"String","EquipmentLocation":"String","ImageURL":"String","ProductDetailsURL":"String","RecordCreatedDate":"0001-01-01T00:00:00.0000000","CreatedByUID":"00000000000000000000000000000000","Active":false,"Notes":"String","Rate":0,"BranchId":"00000000000000000000000000000000","BranchName":"String","Ownership":"String","RentalVendor":"String","RentalStart":"0001-01-01T00:00:00.0000000","RentalEnd":"0001-01-01T00:00:00.0000000","Projects":[{"ProjectID":0,"ProjectUID":"00000000000000000000000000000000","ProjectName":"String","ImageURL":"String","ImageKey":"String","ClientName":"String","ClientPhone":"String","ClientEmail":"String","NotifyCustomerOnVisitCompletion":false,"ClientContactID":0,"ProjectManagerID":0,"ProjectManagerName":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","ActualStartDate":"0001-01-01T00:00:00.0000000","ActualEndDate":"0001-01-01T00:00:00.0000000","JobCount":0,"CrewMemberCount":0,"CrewAvatarsJson":"String","CrewNamesSearch":"String","EquipmentCount":0,"MaterialCount":0,"ProjectStatusID":0,"ProjectStatusDescription":"String","Budget":0,"CostToDate":0,"ProjectLocation":"String","ProjectType":"String","ProjectSponsor":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","ProjectDescription":"String","Scope":"String","StatusId":0,"BranchId":"00000000000000000000000000000000","BranchName":"String","Location":{"Id":"00000000000000000000000000000000","ClientId":"00000000000000000000000000000000","Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Fax":"String","URL":"String","Email":"String","TimeZone":"String","Active":false,"EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000","LocationImage":"String"}}]}]}