| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/Rfp/SchedulePreview |
|---|
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 ResourcedPosition:
position_tag: Optional[str] = None
hours: Optional[float] = None
headcount: Optional[int] = None
source_reference: Optional[str] = None
notes: Optional[str] = None
is_in_catalog: bool = False
contact_i_d: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourcedEquipment:
equipment_i_d: int = 0
equipment_name: Optional[str] = None
make_model: Optional[str] = None
quantity: Optional[float] = None
duration_days: Optional[float] = None
source_reference: Optional[str] = None
notes: Optional[str] = None
is_in_catalog: bool = False
suggested_equipment_i_d: int = 0
suggested_equipment_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourcedMaterial:
material_i_d: int = 0
material_name: Optional[str] = None
make_model: Optional[str] = None
quantity: Optional[float] = None
unit: Optional[str] = None
source_reference: Optional[str] = None
notes: Optional[str] = None
is_in_catalog: bool = False
suggested_material_i_d: int = 0
suggested_material_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaskResourcing:
positions: List[ResourcedPosition] = field(default_factory=list)
equipment: List[ResourcedEquipment] = field(default_factory=list)
materials: List[ResourcedMaterial] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProposedTask:
seq: int = 0
name: Optional[str] = None
category: Optional[str] = None
quantity: Optional[float] = None
unit: Optional[str] = None
source_item_number: Optional[str] = None
source_reference: Optional[str] = None
notes: Optional[str] = None
resourcing: Optional[TaskResourcing] = None
duration_days: Optional[float] = None
depends_on: List[int] = field(default_factory=list)
estimated_start_date: Optional[datetime.datetime] = None
estimated_end_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectProposal:
rfp_document_i_d: int = 0
project_name: Optional[str] = None
client_name: Optional[str] = None
project_type: Optional[str] = None
project_location: Optional[str] = None
scope: Optional[str] = None
project_description: Optional[str] = None
contract_duration_days: Optional[int] = None
bid_due_date: Optional[str] = None
estimated_start_date: Optional[datetime.datetime] = None
estimated_end_date: Optional[datetime.datetime] = None
tasks: List[ProposedTask] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CrewPlanLine:
position_tag: Optional[str] = None
needed: int = 0
naive_total: int = 0
task_assignments: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RfpProposalResponse:
response_status: Optional[ResponseStatus] = None
rfp_document_i_d: int = 0
proposal: Optional[ProjectProposal] = None
crew_plan: List[CrewPlanLine] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RfpSchedulePreviewRequest:
proposal: Optional[ProjectProposal] = None
Python RfpSchedulePreviewRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Rfp/SchedulePreview HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Proposal:
{
RfpDocumentID: 0,
ProjectName: String,
ClientName: String,
ProjectType: String,
ProjectLocation: String,
Scope: String,
ProjectDescription: String,
ContractDurationDays: 0,
BidDueDate: String,
EstimatedStartDate: 0001-01-01,
EstimatedEndDate: 0001-01-01,
Tasks:
[
{
Seq: 0,
Name: String,
Category: String,
Quantity: 0,
Unit: String,
SourceItemNumber: String,
SourceReference: String,
Notes: String,
Resourcing:
{
Positions:
[
{
PositionTag: String,
Hours: 0,
Headcount: 0,
SourceReference: String,
Notes: String,
IsInCatalog: False,
ContactID: 0
}
],
Equipment:
[
{
EquipmentID: 0,
EquipmentName: String,
MakeModel: String,
Quantity: 0,
DurationDays: 0,
SourceReference: String,
Notes: String,
IsInCatalog: False,
SuggestedEquipmentID: 0,
SuggestedEquipmentName: String
}
],
Materials:
[
{
MaterialID: 0,
MaterialName: String,
MakeModel: String,
Quantity: 0,
Unit: String,
SourceReference: String,
Notes: String,
IsInCatalog: False,
SuggestedMaterialID: 0,
SuggestedMaterialName: String
}
]
},
DurationDays: 0,
DependsOn:
[
0
],
EstimatedStartDate: 0001-01-01,
EstimatedEndDate: 0001-01-01
}
]
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
RfpDocumentID: 0,
Proposal:
{
RfpDocumentID: 0,
ProjectName: String,
ClientName: String,
ProjectType: String,
ProjectLocation: String,
Scope: String,
ProjectDescription: String,
ContractDurationDays: 0,
BidDueDate: String,
EstimatedStartDate: 0001-01-01,
EstimatedEndDate: 0001-01-01,
Tasks:
[
{
Seq: 0,
Name: String,
Category: String,
Quantity: 0,
Unit: String,
SourceItemNumber: String,
SourceReference: String,
Notes: String,
Resourcing:
{
Positions:
[
{
PositionTag: String,
Hours: 0,
Headcount: 0,
SourceReference: String,
Notes: String,
IsInCatalog: False,
ContactID: 0
}
],
Equipment:
[
{
EquipmentID: 0,
EquipmentName: String,
MakeModel: String,
Quantity: 0,
DurationDays: 0,
SourceReference: String,
Notes: String,
IsInCatalog: False,
SuggestedEquipmentID: 0,
SuggestedEquipmentName: String
}
],
Materials:
[
{
MaterialID: 0,
MaterialName: String,
MakeModel: String,
Quantity: 0,
Unit: String,
SourceReference: String,
Notes: String,
IsInCatalog: False,
SuggestedMaterialID: 0,
SuggestedMaterialName: String
}
]
},
DurationDays: 0,
DependsOn:
[
0
],
EstimatedStartDate: 0001-01-01,
EstimatedEndDate: 0001-01-01
}
]
},
CrewPlan:
[
{
PositionTag: String,
Needed: 0,
NaiveTotal: 0,
TaskAssignments: 0
}
]
}