Trendsic Platform Service

<back to all web services

PmResourcesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/resources
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PmResCommitment() = 
        member val ProjectName:String = null with get,set
        member val JobName:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set

    [<AllowNullLiteral>]
    type PmResEquipment() = 
        member val EquipmentID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val EquipmentType:String = null with get,set
        member val SerialNumber:String = null with get,set
        member val JobCount:Int32 = new Int32() with get,set
        member val Overbooked:Boolean = new Boolean() with get,set
        member val MaintenanceState:String = null with get,set
        member val Commitments:ResizeArray<PmResCommitment> = new ResizeArray<PmResCommitment>() with get,set

    [<AllowNullLiteral>]
    type PmResMaterial() = 
        member val MaterialID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val MaterialType:String = null with get,set
        member val OnHand:Int32 = new Int32() with get,set
        member val NeededByJobs:Int32 = new Int32() with get,set
        member val QtyNeeded:Int32 = new Int32() with get,set
        member val Shortfall:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PmResourcesResponse() = 
        member val FromDate:String = null with get,set
        member val ToDate:String = null with get,set
        member val OverbookedCount:Int32 = new Int32() with get,set
        member val CommittedCount:Int32 = new Int32() with get,set
        member val ShortfallCount:Int32 = new Int32() with get,set
        member val Equipment:ResizeArray<PmResEquipment> = new ResizeArray<PmResEquipment>() with get,set
        member val Materials:ResizeArray<PmResMaterial> = new ResizeArray<PmResMaterial>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type PmResourcesRequest() = 
        member val Days:Int32 = new Int32() with get,set

F# 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
		}
	}
}