Trendsic Platform Service

<back to all web services

EquipmentMaintenanceRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,OPTIONS/v1/Equipment/{EquipmentID}/maintenance
PUT,OPTIONS/v1/Equipment/{EquipmentID}/maintenance/{EquipmentMaintenanceID}
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 EquipmentMaintenance:
    equipment_maintenance_i_d: int = 0
    equipment_i_d: int = 0
    type: Optional[str] = None
    scheduled_date: Optional[datetime.datetime] = None
    interval_days: Optional[int] = None
    last_serviced: Optional[datetime.datetime] = None
    notes: Optional[str] = None
    status: Optional[str] = None
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None
    next_due: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentMaintenanceResponse:
    response_status: Optional[ResponseStatus] = None
    maintenance: List[EquipmentMaintenance] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentMaintenanceRequest:
    equipment_i_d: int = 0
    equipment_maintenance_i_d: int = 0
    maintenance: List[EquipmentMaintenance] = field(default_factory=list)

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

POST /v1/Equipment/{EquipmentID}/maintenance HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EquipmentMaintenanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <EquipmentID>0</EquipmentID>
  <EquipmentMaintenanceID>0</EquipmentMaintenanceID>
  <Maintenance>
    <EquipmentMaintenance>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <EquipmentID>0</EquipmentID>
      <EquipmentMaintenanceID>0</EquipmentMaintenanceID>
      <IntervalDays>0</IntervalDays>
      <LastServiced>0001-01-01T00:00:00</LastServiced>
      <NextDue>0001-01-01T00:00:00</NextDue>
      <Notes>String</Notes>
      <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
      <Status>String</Status>
      <Type>String</Type>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </EquipmentMaintenance>
  </Maintenance>
</EquipmentMaintenanceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EquipmentMaintenanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Maintenance>
    <EquipmentMaintenance>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <EquipmentID>0</EquipmentID>
      <EquipmentMaintenanceID>0</EquipmentMaintenanceID>
      <IntervalDays>0</IntervalDays>
      <LastServiced>0001-01-01T00:00:00</LastServiced>
      <NextDue>0001-01-01T00:00:00</NextDue>
      <Notes>String</Notes>
      <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
      <Status>String</Status>
      <Type>String</Type>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </EquipmentMaintenance>
  </Maintenance>
  <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>
</EquipmentMaintenanceResponse>