Trendsic Platform Service

<back to all web services

RoutePlanPropertyBookRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/routeplan/propertybook
<?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 RoutePlanPropertyRow implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgreementID=0,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Zip=null,
        /** @var string|null */
        public ?string $Area=null,
        /** @var int */
        public int $DurationMin=0,
        /** @var string|null */
        public ?string $Frequency=null,
        /** @var string|null */
        public ?string $ServiceType=null,
        /** @var string|null */
        public ?string $Acreage=null,
        /** @var int */
        public int $Dow=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AgreementID'])) $this->AgreementID = $o['AgreementID'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Zip'])) $this->Zip = $o['Zip'];
        if (isset($o['Area'])) $this->Area = $o['Area'];
        if (isset($o['DurationMin'])) $this->DurationMin = $o['DurationMin'];
        if (isset($o['Frequency'])) $this->Frequency = $o['Frequency'];
        if (isset($o['ServiceType'])) $this->ServiceType = $o['ServiceType'];
        if (isset($o['Acreage'])) $this->Acreage = $o['Acreage'];
        if (isset($o['Dow'])) $this->Dow = $o['Dow'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AgreementID)) $o['AgreementID'] = $this->AgreementID;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Zip)) $o['Zip'] = $this->Zip;
        if (isset($this->Area)) $o['Area'] = $this->Area;
        if (isset($this->DurationMin)) $o['DurationMin'] = $this->DurationMin;
        if (isset($this->Frequency)) $o['Frequency'] = $this->Frequency;
        if (isset($this->ServiceType)) $o['ServiceType'] = $this->ServiceType;
        if (isset($this->Acreage)) $o['Acreage'] = $this->Acreage;
        if (isset($this->Dow)) $o['Dow'] = $this->Dow;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class RoutePlanPropertyBookRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP RoutePlanPropertyBookRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/routeplan/propertybook HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rows: 
	[
		{
			AgreementID: 0,
			Name: String,
			Zip: String,
			Area: String,
			DurationMin: 0,
			Frequency: String,
			ServiceType: String,
			Acreage: String,
			Dow: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}