regis

CRMSharepointFileRequest

**Requires Authentication**
Required permission:	SharepointFiles

The following routes are available for this service:
POST	/DynamicsCRM/Sharepoint/File

<?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 CRMSharepointFileResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var string|null */
        public ?string $file_base64=null,
        /** @var string|null */
        public ?string $filename=null,
        /** @var string|null */
        public ?string $item_id=null,
        /** @var int */
        public int $filesize=0,
        /** @var string|null */
        public ?string $mimetype=null,
        /** @var string|null */
        public ?string $sharepoint_url=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['file_base64'])) $this->file_base64 = $o['file_base64'];
        if (isset($o['filename'])) $this->filename = $o['filename'];
        if (isset($o['item_id'])) $this->item_id = $o['item_id'];
        if (isset($o['filesize'])) $this->filesize = $o['filesize'];
        if (isset($o['mimetype'])) $this->mimetype = $o['mimetype'];
        if (isset($o['sharepoint_url'])) $this->sharepoint_url = $o['sharepoint_url'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->file_base64)) $o['file_base64'] = $this->file_base64;
        if (isset($this->filename)) $o['filename'] = $this->filename;
        if (isset($this->item_id)) $o['item_id'] = $this->item_id;
        if (isset($this->filesize)) $o['filesize'] = $this->filesize;
        if (isset($this->mimetype)) $o['mimetype'] = $this->mimetype;
        if (isset($this->sharepoint_url)) $o['sharepoint_url'] = $this->sharepoint_url;
        return empty($o) ? new class(){} : $o;
    }
}

class CRMSharepointFileRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $filename=null,
        /** @var string|null */
        public ?string $item_id=null,
        /** @var bool|null */
        public ?bool $convert_to_pdf=null,
        /** @var bool|null */
        public ?bool $as_thumbnail=null,
        /** @var bool|null */
        public ?bool $is_development=null,
        /** @var bool|null */
        public ?bool $is_invoice=null,
        /** @var bool|null */
        public ?bool $is_tax_receipt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['filename'])) $this->filename = $o['filename'];
        if (isset($o['item_id'])) $this->item_id = $o['item_id'];
        if (isset($o['convert_to_pdf'])) $this->convert_to_pdf = $o['convert_to_pdf'];
        if (isset($o['as_thumbnail'])) $this->as_thumbnail = $o['as_thumbnail'];
        if (isset($o['is_development'])) $this->is_development = $o['is_development'];
        if (isset($o['is_invoice'])) $this->is_invoice = $o['is_invoice'];
        if (isset($o['is_tax_receipt'])) $this->is_tax_receipt = $o['is_tax_receipt'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->filename)) $o['filename'] = $this->filename;
        if (isset($this->item_id)) $o['item_id'] = $this->item_id;
        if (isset($this->convert_to_pdf)) $o['convert_to_pdf'] = $this->convert_to_pdf;
        if (isset($this->as_thumbnail)) $o['as_thumbnail'] = $this->as_thumbnail;
        if (isset($this->is_development)) $o['is_development'] = $this->is_development;
        if (isset($this->is_invoice)) $o['is_invoice'] = $this->is_invoice;
        if (isset($this->is_tax_receipt)) $o['is_tax_receipt'] = $this->is_tax_receipt;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CRMSharepointFileRequest 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 /DynamicsCRM/Sharepoint/File HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	filename: String,
	item_id: String,
	convert_to_pdf: False,
	as_thumbnail: False,
	is_development: False,
	is_invoice: False,
	is_tax_receipt: False
}

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
		}
	},
	file_base64: String,
	filename: String,
	item_id: String,
	filesize: 0,
	mimetype: String,
	sharepoint_url: String
}