Trendsic Platform Service

<back to all web services

JobEquipmentRequest

The following routes are available for this service:
PUT,OPTIONS/v1/Job/equipment
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 CalendarEvent:
    calendar_event_id: int = 0
    calendar_id: Optional[str] = None
    event_start: datetime.datetime = datetime.datetime(1, 1, 1)
    event_end: datetime.datetime = datetime.datetime(1, 1, 1)
    location: Optional[str] = None
    summary: Optional[str] = None
    description: Optional[str] = None
    event_type_id: int = 0
    recurrence: bool = False
    recurrence_frequency: Optional[str] = None
    recurrence_by: Optional[str] = None
    recurrence_by_value: Optional[str] = None
    recurrence_until: datetime.datetime = datetime.datetime(1, 1, 1)
    created_by: Optional[str] = None
    created_by_name: Optional[str] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    modified_by: Optional[str] = None
    date_modified: datetime.datetime = datetime.datetime(1, 1, 1)
    deleted: bool = False
    time_zone: Optional[str] = None
    offset: int = 0
    text_reminder_sent_date: datetime.datetime = datetime.datetime(1, 1, 1)
    confirmed: bool = False
    confirmation_text_id: Optional[str] = None
    first_text_reminder_id: Optional[str] = None
    second_text_reminder_id: Optional[str] = None
    location_u_i_d: Optional[str] = None
    agent_reminder_sent_date: datetime.datetime = datetime.datetime(1, 1, 1)
    contact_id: int = 0
    is_private: bool = False
    project_i_d: int = 0
    job_i_d: int = 0
    project_start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    project_end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    max_crew_end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    max_equipment_end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    check_in_id: Optional[str] = None
    all_day: bool = False
    job_name: Optional[str] = None
    job_status_name: Optional[str] = None
    job_status_id: int = 0
    project_name: Optional[str] = None
    resource_id: int = 0
    resource_name: Optional[str] = None
    original__event_start: datetime.datetime = datetime.datetime(1, 1, 1)
    original__recurrence: bool = False
    original__recurrence_frequency: Optional[str] = None
    original__recurrence_by: Optional[str] = None
    original__recurrence_by_value: Optional[str] = None
    original__recurrence_until: datetime.datetime = datetime.datetime(1, 1, 1)
    checksum: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Job:
    job_i_d: int = 0
    job_name: Optional[str] = None
    job_type_i_d: int = 0
    expected_start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    actual_start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    expected_completion_date: datetime.datetime = datetime.datetime(1, 1, 1)
    actual_end_date: datetime.datetime = datetime.datetime(1, 1, 1)
    active: bool = False
    created_by_u_i_d: Optional[str] = None
    project_i_d: int = 0
    status_id: int = 0
    advanced_scheduling: bool = False
    show_times: bool = False
    schedule: List[CalendarEvent] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JobResponse:
    response_status: Optional[ResponseStatus] = None
    job: List[Job] = field(default_factory=list)
    requires_confirm: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JobEquipmentRequest:
    project_i_d: int = 0
    job_i_d: int = 0
    equipment_i_d: int = 0
    add_remove: int = 0

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

PUT /v1/Job/equipment HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ProjectID":0,"JobID":0,"EquipmentID":0,"AddRemove":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Job":[{"JobID":0,"JobName":"String","JobTypeID":0,"ExpectedStartDate":"0001-01-01T00:00:00.0000000","ActualStartDate":"0001-01-01T00:00:00.0000000","ExpectedCompletionDate":"0001-01-01T00:00:00.0000000","ActualEndDate":"0001-01-01T00:00:00.0000000","Active":false,"CreatedByUID":"00000000000000000000000000000000","ProjectID":0,"StatusId":0,"AdvancedScheduling":false,"ShowTimes":false,"Schedule":[{"CalendarEventId":0,"CalendarId":"00000000000000000000000000000000","EventStart":"0001-01-01T00:00:00.0000000","EventEnd":"0001-01-01T00:00:00.0000000","Location":"String","Summary":"String","Description":"String","EventTypeId":0,"Recurrence":false,"RecurrenceFrequency":"String","RecurrenceBy":"String","RecurrenceByValue":"String","RecurrenceUntil":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CreatedByName":"String","DateCreated":"0001-01-01T00:00:00.0000000","ModifiedBy":"String","DateModified":"0001-01-01T00:00:00.0000000","Deleted":false,"TimeZone":"String","Offset":0,"TextReminderSentDate":"0001-01-01T00:00:00.0000000","Confirmed":false,"ConfirmationTextId":"String","FirstTextReminderId":"String","SecondTextReminderId":"String","LocationUID":"00000000000000000000000000000000","AgentReminderSentDate":"0001-01-01T00:00:00.0000000","ContactId":0,"IsPrivate":false,"ProjectID":0,"JobID":0,"ProjectStartDate":"0001-01-01T00:00:00.0000000","ProjectEndDate":"0001-01-01T00:00:00.0000000","MaxCrewEndDate":"0001-01-01T00:00:00.0000000","MaxEquipmentEndDate":"0001-01-01T00:00:00.0000000","CheckInId":"00000000000000000000000000000000","AllDay":false,"JobName":"String","JobStatusName":"String","JobStatusId":0,"ProjectName":"String","ResourceId":0,"ResourceName":"String","Original_EventStart":"0001-01-01T00:00:00.0000000","Original_Recurrence":false,"Original_RecurrenceFrequency":"String","Original_RecurrenceBy":"String","Original_RecurrenceByValue":"String","Original_RecurrenceUntil":"0001-01-01T00:00:00.0000000","Checksum":"String"}]}],"RequiresConfirm":false}