regis

<back to all web services

CRMSharepointFileUploadRequest

Requires Authentication
Required permission:SharepointFiles
The following routes are available for this service:
POST/DynamicsCRM/Sharepoint/File/Upload
<?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 CRMSharepointFileUploadRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $filename=null,
        /** @var string|null */
        public ?string $file_base64=null,
        /** @var bool|null */
        public ?bool $is_invoice=null
    ) {
    }

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

PHP CRMSharepointFileUploadRequest 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 /DynamicsCRM/Sharepoint/File/Upload HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CRMSharepointFileUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <file_base64>String</file_base64>
  <filename>String</filename>
  <is_invoice>false</is_invoice>
</CRMSharepointFileUploadRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CRMSharepointFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Responses">
  <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>
  <file_base64>String</file_base64>
  <filename>String</filename>
  <filesize>0</filesize>
  <item_id>String</item_id>
  <mimetype>String</mimetype>
  <sharepoint_url>String</sharepoint_url>
</CRMSharepointFileResponse>