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}
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class EquipmentMaintenance implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $EquipmentMaintenanceID=0,
        /** @var int */
        public int $EquipmentID=0,
        /** @var string|null */
        public ?string $Type=null,
        /** @var DateTime|null */
        public ?DateTime $ScheduledDate=null,
        /** @var int|null */
        public ?int $IntervalDays=null,
        /** @var DateTime|null */
        public ?DateTime $LastServiced=null,
        /** @var string|null */
        public ?string $Notes=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $NextDue=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['EquipmentMaintenanceID'])) $this->EquipmentMaintenanceID = $o['EquipmentMaintenanceID'];
        if (isset($o['EquipmentID'])) $this->EquipmentID = $o['EquipmentID'];
        if (isset($o['Type'])) $this->Type = $o['Type'];
        if (isset($o['ScheduledDate'])) $this->ScheduledDate = JsonConverters::from('DateTime', $o['ScheduledDate']);
        if (isset($o['IntervalDays'])) $this->IntervalDays = $o['IntervalDays'];
        if (isset($o['LastServiced'])) $this->LastServiced = JsonConverters::from('DateTime', $o['LastServiced']);
        if (isset($o['Notes'])) $this->Notes = $o['Notes'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
        if (isset($o['NextDue'])) $this->NextDue = JsonConverters::from('DateTime', $o['NextDue']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->EquipmentMaintenanceID)) $o['EquipmentMaintenanceID'] = $this->EquipmentMaintenanceID;
        if (isset($this->EquipmentID)) $o['EquipmentID'] = $this->EquipmentID;
        if (isset($this->Type)) $o['Type'] = $this->Type;
        if (isset($this->ScheduledDate)) $o['ScheduledDate'] = JsonConverters::to('DateTime', $this->ScheduledDate);
        if (isset($this->IntervalDays)) $o['IntervalDays'] = $this->IntervalDays;
        if (isset($this->LastServiced)) $o['LastServiced'] = JsonConverters::to('DateTime', $this->LastServiced);
        if (isset($this->Notes)) $o['Notes'] = $this->Notes;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
        if (isset($this->NextDue)) $o['NextDue'] = JsonConverters::to('DateTime', $this->NextDue);
        return empty($o) ? new class(){} : $o;
    }
}

class EquipmentMaintenanceResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<EquipmentMaintenance>|null */
        public ?array $Maintenance=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
        if (isset($o['Maintenance'])) $this->Maintenance = JsonConverters::fromArray('EquipmentMaintenance', $o['Maintenance']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        if (isset($this->Maintenance)) $o['Maintenance'] = JsonConverters::toArray('EquipmentMaintenance', $this->Maintenance);
        return empty($o) ? new class(){} : $o;
    }
}

class EquipmentMaintenanceRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $EquipmentID=0,
        /** @var int */
        public int $EquipmentMaintenanceID=0,
        /** @var array<EquipmentMaintenance>|null */
        public ?array $Maintenance=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['EquipmentID'])) $this->EquipmentID = $o['EquipmentID'];
        if (isset($o['EquipmentMaintenanceID'])) $this->EquipmentMaintenanceID = $o['EquipmentMaintenanceID'];
        if (isset($o['Maintenance'])) $this->Maintenance = JsonConverters::fromArray('EquipmentMaintenance', $o['Maintenance']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->EquipmentID)) $o['EquipmentID'] = $this->EquipmentID;
        if (isset($this->EquipmentMaintenanceID)) $o['EquipmentMaintenanceID'] = $this->EquipmentMaintenanceID;
        if (isset($this->Maintenance)) $o['Maintenance'] = JsonConverters::toArray('EquipmentMaintenance', $this->Maintenance);
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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>