Trendsic Platform Service

<back to all web services

PmResourcesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/resources
import Foundation
import ServiceStack

public class PmResourcesRequest : Codable
{
    public var days:Int

    required public init(){}
}

public class PmResourcesResponse : Codable
{
    public var fromDate:String
    public var toDate:String
    public var overbookedCount:Int
    public var committedCount:Int
    public var shortfallCount:Int
    public var equipment:[PmResEquipment] = []
    public var materials:[PmResMaterial] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class PmResEquipment : Codable
{
    public var equipmentID:Int
    public var name:String
    public var equipmentType:String
    public var serialNumber:String
    public var jobCount:Int
    public var overbooked:Bool
    public var maintenanceState:String
    public var commitments:[PmResCommitment] = []

    required public init(){}
}

public class PmResCommitment : Codable
{
    public var projectName:String
    public var jobName:String
    public var startDate:String
    public var endDate:String

    required public init(){}
}

public class PmResMaterial : Codable
{
    public var materialID:Int
    public var name:String
    public var materialType:String
    public var onHand:Int
    public var neededByJobs:Int
    public var qtyNeeded:Int
    public var shortfall:Bool

    required public init(){}
}


Swift PmResourcesRequest DTOs

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

HTTP + JSV

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

GET /v1/pm/resources HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FromDate: String,
	ToDate: String,
	OverbookedCount: 0,
	CommittedCount: 0,
	ShortfallCount: 0,
	Equipment: 
	[
		{
			EquipmentID: 0,
			Name: String,
			EquipmentType: String,
			SerialNumber: String,
			JobCount: 0,
			Overbooked: False,
			MaintenanceState: String,
			Commitments: 
			[
				{
					ProjectName: String,
					JobName: String,
					StartDate: String,
					EndDate: String
				}
			]
		}
	],
	Materials: 
	[
		{
			MaterialID: 0,
			Name: String,
			MaterialType: String,
			OnHand: 0,
			NeededByJobs: 0,
			QtyNeeded: 0,
			Shortfall: False
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}