| GET,POST,PUT,DELETE,OPTIONS | /v1/Project/Materials/{ProjectID} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Project/Materials/{ProjectID}/{JobID} |
import Foundation
import ServiceStack
public class ProjectMaterialListRequest : Codable
{
public var projectID:Int
public var jobID:Int
public var projectMaterials:[Material] = []
required public init(){}
}
public class Material : Codable
{
public var materialID:Int
public var materialName:String
public var materialTypeID:Int16
public var materialStatusID:UInt8
public var quantity:Int
public var supplier:String
public var orderDate:Date
public var deliveryDate:Date
public var onSiteDate:Date
public var materialLocation:String
public var manufacturer:String
public var serialNumber:String
public var barCode:String
public var trackingInfo:String
public var materialDescription:String
public var notes:String
public var imageURL:String
public var detailsURL:String
public var createdByUID:String
public var active:Bool
public var recordCreatedDate:Date
public var statusId:Int
public var materialTypeName:String
public var cost:Double
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 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 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
required public init(){}
}
public class ProjectMaterialListResponse : Codable
{
public var responseStatus:ResponseStatus
public var projectMaterials:[ProjectMaterial] = []
required public init(){}
}
public class ProjectMaterial : Material
{
public var projectMaterialID:Int
public var projectID:Int
public var projectEndDate:Date
public var materialCost:Double
public var jobID:Int
public var billedMaterialCost:Double
public var materialQty:Int
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case projectMaterialID
case projectID
case projectEndDate
case materialCost
case jobID
case billedMaterialCost
case materialQty
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
projectMaterialID = try container.decodeIfPresent(Int.self, forKey: .projectMaterialID)
projectID = try container.decodeIfPresent(Int.self, forKey: .projectID)
projectEndDate = try container.decodeIfPresent(Date.self, forKey: .projectEndDate)
materialCost = try container.decodeIfPresent(Double.self, forKey: .materialCost)
jobID = try container.decodeIfPresent(Int.self, forKey: .jobID)
billedMaterialCost = try container.decodeIfPresent(Double.self, forKey: .billedMaterialCost)
materialQty = try container.decodeIfPresent(Int.self, forKey: .materialQty)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if projectMaterialID != nil { try container.encode(projectMaterialID, forKey: .projectMaterialID) }
if projectID != nil { try container.encode(projectID, forKey: .projectID) }
if projectEndDate != nil { try container.encode(projectEndDate, forKey: .projectEndDate) }
if materialCost != nil { try container.encode(materialCost, forKey: .materialCost) }
if jobID != nil { try container.encode(jobID, forKey: .jobID) }
if billedMaterialCost != nil { try container.encode(billedMaterialCost, forKey: .billedMaterialCost) }
if materialQty != nil { try container.encode(materialQty, forKey: .materialQty) }
}
}
Swift ProjectMaterialListRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Project/Materials/{ProjectID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ProjectID":0,"JobID":0,"ProjectMaterials":[{"MaterialID":0,"MaterialName":"String","MaterialTypeID":0,"MaterialStatusID":0,"Quantity":0,"Supplier":"String","OrderDate":"0001-01-01T00:00:00.0000000","DeliveryDate":"0001-01-01T00:00:00.0000000","OnSiteDate":"0001-01-01T00:00:00.0000000","MaterialLocation":"String","Manufacturer":"String","SerialNumber":"String","BarCode":"String","TrackingInfo":"String","MaterialDescription":"String","Notes":"String","ImageURL":"String","DetailsURL":"String","CreatedByUID":"00000000000000000000000000000000","Active":false,"RecordCreatedDate":"0001-01-01T00:00:00.0000000","StatusId":0,"MaterialTypeName":"String","Cost":0,"Projects":[{"ProjectID":0,"ProjectUID":"00000000000000000000000000000000","ProjectName":"String","ImageURL":"String","ImageKey":"String","ClientName":"String","ClientPhone":"String","ClientEmail":"String","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,"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}]}]}
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"}},"ProjectMaterials":[{"ProjectMaterialID":0,"ProjectID":0,"ProjectEndDate":"0001-01-01T00:00:00.0000000","MaterialCost":0,"JobID":0,"BilledMaterialCost":0,"MaterialQty":0,"MaterialID":0,"MaterialName":"String","MaterialTypeID":0,"MaterialStatusID":0,"Quantity":0,"Supplier":"String","OrderDate":"0001-01-01T00:00:00.0000000","DeliveryDate":"0001-01-01T00:00:00.0000000","OnSiteDate":"0001-01-01T00:00:00.0000000","MaterialLocation":"String","Manufacturer":"String","SerialNumber":"String","BarCode":"String","TrackingInfo":"String","MaterialDescription":"String","Notes":"String","ImageURL":"String","DetailsURL":"String","CreatedByUID":"00000000000000000000000000000000","Active":false,"RecordCreatedDate":"0001-01-01T00:00:00.0000000","StatusId":0,"MaterialTypeName":"String","Cost":0,"Projects":[{"ProjectID":0,"ProjectUID":"00000000000000000000000000000000","ProjectName":"String","ImageURL":"String","ImageKey":"String","ClientName":"String","ClientPhone":"String","ClientEmail":"String","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,"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}]}]}