regis

CRMSharepointFileRequest

**Requires Authentication**
Required permission:	SharepointFiles

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

"use strict";
export class CRMSharepointFileResponse {
    /** @param {{responseStatus?:ResponseStatus,file_base64?:string,filename?:string,item_id?:string,filesize?:number,mimetype?:string,sharepoint_url?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    file_base64;
    /** @type {string} */
    filename;
    /** @type {string} */
    item_id;
    /** @type {number} */
    filesize;
    /** @type {string} */
    mimetype;
    /** @type {string} */
    sharepoint_url;
}
export class CRMSharepointFileRequest {
    /** @param {{filename?:string,item_id?:string,convert_to_pdf?:boolean,as_thumbnail?:boolean,is_development?:boolean,is_invoice?:boolean,is_tax_receipt?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    filename;
    /** @type {string} */
    item_id;
    /** @type {boolean} */
    convert_to_pdf;
    /** @type {boolean} */
    as_thumbnail;
    /** @type {boolean} */
    is_development;
    /** @type {boolean} */
    is_invoice;
    /** @type {boolean} */
    is_tax_receipt;
}

JavaScript CRMSharepointFileRequest 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 HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CRMSharepointFileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.DynamicsCRM.Requests">
  <as_thumbnail>false</as_thumbnail>
  <convert_to_pdf>false</convert_to_pdf>
  <filename>String</filename>
  <is_development>false</is_development>
  <is_invoice>false</is_invoice>
  <is_tax_receipt>false</is_tax_receipt>
  <item_id>String</item_id>
</CRMSharepointFileRequest>

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>