Trendsic Platform Service

<back to all web services

FieldLogPhotoRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/fieldlog/photo
<?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 FieldLogPhoto implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Key=null,
        /** @var string|null */
        public ?string $Url=null,
        /** @var string|null */
        public ?string $FileName=null
    ) {
    }

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

class FieldLogPhotoResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var bool|null */
        public ?bool $Success=null,
        /** @var array<FieldLogPhoto>|null */
        public ?array $Photos=null
    ) {
    }

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

class FieldLogPhotoRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $FieldLogUID='',
        /** @var string|null */
        public ?string $Section=null
    ) {
    }

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

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

POST /v1/fieldlog/photo HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FieldLogUID: 00000000000000000000000000000000,
	Section: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Success: False,
	Photos: 
	[
		{
			Key: String,
			Url: String,
			FileName: String
		}
	]
}