Trendsic Platform Service

<back to all web services

JobStatusRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/JobStatus/{JobStatusID}
GET,POST,PUT,DELETE,OPTIONS/v1/JobStatus
<?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 JobStatus implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $JobStatusID=0,
        /** @var string|null */
        public ?string $StatusName=null,
        /** @var string|null */
        public ?string $StatusDescription=null,
        /** @var int */
        public int $ProgressionOrder=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['JobStatusID'])) $this->JobStatusID = $o['JobStatusID'];
        if (isset($o['StatusName'])) $this->StatusName = $o['StatusName'];
        if (isset($o['StatusDescription'])) $this->StatusDescription = $o['StatusDescription'];
        if (isset($o['ProgressionOrder'])) $this->ProgressionOrder = $o['ProgressionOrder'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->JobStatusID)) $o['JobStatusID'] = $this->JobStatusID;
        if (isset($this->StatusName)) $o['StatusName'] = $this->StatusName;
        if (isset($this->StatusDescription)) $o['StatusDescription'] = $this->StatusDescription;
        if (isset($this->ProgressionOrder)) $o['ProgressionOrder'] = $this->ProgressionOrder;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class JobStatusRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $JobStatusID=0,
        /** @var array<JobStatus>|null */
        public ?array $JobStatus=null
    ) {
    }

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

PHP JobStatusRequest 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/JobStatus/{JobStatusID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JobStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <JobStatus>
    <JobStatus>
      <JobStatusID>0</JobStatusID>
      <ProgressionOrder>0</ProgressionOrder>
      <StatusDescription>String</StatusDescription>
      <StatusName>String</StatusName>
    </JobStatus>
  </JobStatus>
  <JobStatusID>0</JobStatusID>
</JobStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JobStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <JobStatus>
    <JobStatus>
      <JobStatusID>0</JobStatusID>
      <ProgressionOrder>0</ProgressionOrder>
      <StatusDescription>String</StatusDescription>
      <StatusName>String</StatusName>
    </JobStatus>
  </JobStatus>
  <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>
</JobStatusResponse>