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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmResCommitment:
    project_name: Optional[str] = None
    job_name: Optional[str] = None
    start_date: Optional[str] = None
    end_date: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmResEquipment:
    equipment_i_d: int = 0
    name: Optional[str] = None
    equipment_type: Optional[str] = None
    serial_number: Optional[str] = None
    job_count: int = 0
    overbooked: bool = False
    maintenance_state: Optional[str] = None
    commitments: List[PmResCommitment] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmResMaterial:
    material_i_d: int = 0
    name: Optional[str] = None
    material_type: Optional[str] = None
    on_hand: int = 0
    needed_by_jobs: int = 0
    qty_needed: int = 0
    shortfall: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmResourcesResponse:
    from_date: Optional[str] = None
    to_date: Optional[str] = None
    overbooked_count: int = 0
    committed_count: int = 0
    shortfall_count: int = 0
    equipment: List[PmResEquipment] = field(default_factory=list)
    materials: List[PmResMaterial] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PmResourcesRequest:
    days: int = 0

Python 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>