Trendsic Platform Service

<back to all web services

MaterialShortfallsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/material-shortfalls
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 MaterialShortfall:
    material_i_d: int = 0
    name: Optional[str] = None
    material_type: Optional[str] = None
    on_hand: Decimal = decimal.Decimal(0)
    qty_needed: Decimal = decimal.Decimal(0)
    short_qty: Decimal = decimal.Decimal(0)
    unit: Optional[str] = None
    unit_price: Decimal = decimal.Decimal(0)
    est_u_s_d: Decimal = decimal.Decimal(0)
    vendor: Optional[str] = None
    job_start_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MaterialShortfallsResponse:
    response_status: Optional[ResponseStatus] = None
    project_i_d: int = 0
    shortfalls: List[MaterialShortfall] = field(default_factory=list)


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

Python MaterialShortfallsRequest 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/projects/{ProjectID}/material-shortfalls HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MaterialShortfallsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ProjectID>0</ProjectID>
  <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>
  <Shortfalls>
    <MaterialShortfall>
      <EstUSD>0</EstUSD>
      <JobStartDate>0001-01-01T00:00:00</JobStartDate>
      <MaterialID>0</MaterialID>
      <MaterialType>String</MaterialType>
      <Name>String</Name>
      <OnHand>0</OnHand>
      <QtyNeeded>0</QtyNeeded>
      <ShortQty>0</ShortQty>
      <Unit>String</Unit>
      <UnitPrice>0</UnitPrice>
      <Vendor>String</Vendor>
    </MaterialShortfall>
  </Shortfalls>
</MaterialShortfallsResponse>