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 'package:servicestack/servicestack.dart';

class PmResCommitment implements IConvertible
{
    String? ProjectName;
    String? JobName;
    String? StartDate;
    String? EndDate;

    PmResCommitment({this.ProjectName,this.JobName,this.StartDate,this.EndDate});
    PmResCommitment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ProjectName = json['ProjectName'];
        JobName = json['JobName'];
        StartDate = json['StartDate'];
        EndDate = json['EndDate'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ProjectName': ProjectName,
        'JobName': JobName,
        'StartDate': StartDate,
        'EndDate': EndDate
    };

    getTypeName() => "PmResCommitment";
    TypeContext? context = _ctx;
}

class PmResEquipment implements IConvertible
{
    int? EquipmentID;
    String? Name;
    String? EquipmentType;
    String? SerialNumber;
    int? JobCount;
    bool? Overbooked;
    String? MaintenanceState;
    List<PmResCommitment>? Commitments = [];

    PmResEquipment({this.EquipmentID,this.Name,this.EquipmentType,this.SerialNumber,this.JobCount,this.Overbooked,this.MaintenanceState,this.Commitments});
    PmResEquipment.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        EquipmentID = json['EquipmentID'];
        Name = json['Name'];
        EquipmentType = json['EquipmentType'];
        SerialNumber = json['SerialNumber'];
        JobCount = json['JobCount'];
        Overbooked = json['Overbooked'];
        MaintenanceState = json['MaintenanceState'];
        Commitments = JsonConverters.fromJson(json['Commitments'],'List<PmResCommitment>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'EquipmentID': EquipmentID,
        'Name': Name,
        'EquipmentType': EquipmentType,
        'SerialNumber': SerialNumber,
        'JobCount': JobCount,
        'Overbooked': Overbooked,
        'MaintenanceState': MaintenanceState,
        'Commitments': JsonConverters.toJson(Commitments,'List<PmResCommitment>',context!)
    };

    getTypeName() => "PmResEquipment";
    TypeContext? context = _ctx;
}

class PmResMaterial implements IConvertible
{
    int? MaterialID;
    String? Name;
    String? MaterialType;
    int? OnHand;
    int? NeededByJobs;
    int? QtyNeeded;
    bool? Shortfall;

    PmResMaterial({this.MaterialID,this.Name,this.MaterialType,this.OnHand,this.NeededByJobs,this.QtyNeeded,this.Shortfall});
    PmResMaterial.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MaterialID = json['MaterialID'];
        Name = json['Name'];
        MaterialType = json['MaterialType'];
        OnHand = json['OnHand'];
        NeededByJobs = json['NeededByJobs'];
        QtyNeeded = json['QtyNeeded'];
        Shortfall = json['Shortfall'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MaterialID': MaterialID,
        'Name': Name,
        'MaterialType': MaterialType,
        'OnHand': OnHand,
        'NeededByJobs': NeededByJobs,
        'QtyNeeded': QtyNeeded,
        'Shortfall': Shortfall
    };

    getTypeName() => "PmResMaterial";
    TypeContext? context = _ctx;
}

class PmResourcesResponse implements IConvertible
{
    String? FromDate;
    String? ToDate;
    int? OverbookedCount;
    int? CommittedCount;
    int? ShortfallCount;
    List<PmResEquipment>? Equipment = [];
    List<PmResMaterial>? Materials = [];
    ResponseStatus? ResponseStatus;

    PmResourcesResponse({this.FromDate,this.ToDate,this.OverbookedCount,this.CommittedCount,this.ShortfallCount,this.Equipment,this.Materials,this.ResponseStatus});
    PmResourcesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FromDate = json['FromDate'];
        ToDate = json['ToDate'];
        OverbookedCount = json['OverbookedCount'];
        CommittedCount = json['CommittedCount'];
        ShortfallCount = json['ShortfallCount'];
        Equipment = JsonConverters.fromJson(json['Equipment'],'List<PmResEquipment>',context!);
        Materials = JsonConverters.fromJson(json['Materials'],'List<PmResMaterial>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FromDate': FromDate,
        'ToDate': ToDate,
        'OverbookedCount': OverbookedCount,
        'CommittedCount': CommittedCount,
        'ShortfallCount': ShortfallCount,
        'Equipment': JsonConverters.toJson(Equipment,'List<PmResEquipment>',context!),
        'Materials': JsonConverters.toJson(Materials,'List<PmResMaterial>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "PmResourcesResponse";
    TypeContext? context = _ctx;
}

class PmResourcesRequest implements IConvertible
{
    int? Days;

    PmResourcesRequest({this.Days});
    PmResourcesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Days = json['Days'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Days': Days
    };

    getTypeName() => "PmResourcesRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'PmResCommitment': TypeInfo(TypeOf.Class, create:() => PmResCommitment()),
    'PmResEquipment': TypeInfo(TypeOf.Class, create:() => PmResEquipment()),
    'List<PmResCommitment>': TypeInfo(TypeOf.Class, create:() => <PmResCommitment>[]),
    'PmResMaterial': TypeInfo(TypeOf.Class, create:() => PmResMaterial()),
    'PmResourcesResponse': TypeInfo(TypeOf.Class, create:() => PmResourcesResponse()),
    'List<PmResEquipment>': TypeInfo(TypeOf.Class, create:() => <PmResEquipment>[]),
    'List<PmResMaterial>': TypeInfo(TypeOf.Class, create:() => <PmResMaterial>[]),
    'PmResourcesRequest': TypeInfo(TypeOf.Class, create:() => PmResourcesRequest()),
});

Dart 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
		}
	}
}