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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}