| GET,POST,PUT,DELETE,OPTIONS | /v1/ProjectMaterialSingle/{ProjectMaterialID} |
|---|
import Foundation
import ServiceStack
public class ProjectMaterialSingleRequest : Codable
{
public var projectMaterialID:Int
public var materialID:Int
public var material:[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 materialStatusName:String
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 ProjectMaterialSingleResponse : Codable
{
public var responseStatus:ResponseStatus
public var material:[ProjectMaterial] = []
required public init(){}
}
public class ProjectMaterial : Material
{
public var projectMaterialID:Int
public var projectID:Int
public var projectEndDate:Date
public var firstJobUseDate:Date
public var lastJobUseDate:Date
public var materialCost:Double
public var jobID:Int
public var billedMaterialCost:Double
public var materialQty:Int
public var source:String
public var allocated:Int
public var availableQty:Int
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case projectMaterialID
case projectID
case projectEndDate
case firstJobUseDate
case lastJobUseDate
case materialCost
case jobID
case billedMaterialCost
case materialQty
case source
case allocated
case availableQty
}
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)
firstJobUseDate = try container.decodeIfPresent(Date.self, forKey: .firstJobUseDate)
lastJobUseDate = try container.decodeIfPresent(Date.self, forKey: .lastJobUseDate)
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)
source = try container.decodeIfPresent(String.self, forKey: .source)
allocated = try container.decodeIfPresent(Int.self, forKey: .allocated)
availableQty = try container.decodeIfPresent(Int.self, forKey: .availableQty)
}
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 firstJobUseDate != nil { try container.encode(firstJobUseDate, forKey: .firstJobUseDate) }
if lastJobUseDate != nil { try container.encode(lastJobUseDate, forKey: .lastJobUseDate) }
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) }
if source != nil { try container.encode(source, forKey: .source) }
if allocated != nil { try container.encode(allocated, forKey: .allocated) }
if availableQty != nil { try container.encode(availableQty, forKey: .availableQty) }
}
}
Swift ProjectMaterialSingleRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/ProjectMaterialSingle/{ProjectMaterialID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ProjectMaterialID: 0,
MaterialID: 0,
Material:
[
{
MaterialID: 0,
MaterialName: String,
MaterialTypeID: 0,
MaterialStatusID: 0,
Quantity: 0,
Supplier: String,
OrderDate: 0001-01-01,
DeliveryDate: 0001-01-01,
OnSiteDate: 0001-01-01,
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-01,
StatusId: 0,
MaterialTypeName: String,
Cost: 0,
MaterialStatusName: String,
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-01,
EndDate: 0001-01-01,
ActualStartDate: 0001-01-01,
ActualEndDate: 0001-01-01,
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-01,
UpdatedAt: 0001-01-01,
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-01,
ModDate: 0001-01-01,
LocationImage: String
}
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Material:
[
{
ProjectMaterialID: 0,
ProjectID: 0,
ProjectEndDate: 0001-01-01,
FirstJobUseDate: 0001-01-01,
LastJobUseDate: 0001-01-01,
MaterialCost: 0,
JobID: 0,
BilledMaterialCost: 0,
MaterialQty: 0,
Source: String,
Allocated: 0,
AvailableQty: 0,
MaterialID: 0,
MaterialName: String,
MaterialTypeID: 0,
MaterialStatusID: 0,
Quantity: 0,
Supplier: String,
OrderDate: 0001-01-01,
DeliveryDate: 0001-01-01,
OnSiteDate: 0001-01-01,
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-01,
StatusId: 0,
MaterialTypeName: String,
Cost: 0,
MaterialStatusName: String,
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-01,
EndDate: 0001-01-01,
ActualStartDate: 0001-01-01,
ActualEndDate: 0001-01-01,
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-01,
UpdatedAt: 0001-01-01,
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-01,
ModDate: 0001-01-01,
LocationImage: String
}
}
]
}
]
}