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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PmResourcesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CommittedCount>0</CommittedCount>
  <Equipment>
    <PmResEquipment>
      <Commitments>
        <PmResCommitment>
          <EndDate>String</EndDate>
          <JobName>String</JobName>
          <ProjectName>String</ProjectName>
          <StartDate>String</StartDate>
        </PmResCommitment>
      </Commitments>
      <EquipmentID>0</EquipmentID>
      <EquipmentType>String</EquipmentType>
      <JobCount>0</JobCount>
      <MaintenanceState>String</MaintenanceState>
      <Name>String</Name>
      <Overbooked>false</Overbooked>
      <SerialNumber>String</SerialNumber>
    </PmResEquipment>
  </Equipment>
  <FromDate>String</FromDate>
  <Materials>
    <PmResMaterial>
      <MaterialID>0</MaterialID>
      <MaterialType>String</MaterialType>
      <Name>String</Name>
      <NeededByJobs>0</NeededByJobs>
      <OnHand>0</OnHand>
      <QtyNeeded>0</QtyNeeded>
      <Shortfall>false</Shortfall>
    </PmResMaterial>
  </Materials>
  <OverbookedCount>0</OverbookedCount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ShortfallCount>0</ShortfallCount>
  <ToDate>String</ToDate>
</PmResourcesResponse>