regis

<back to all web services

CRMSharepointFileRequest

Requires Authentication
Required permission:SharepointFiles
The following routes are available for this service:
POST/DynamicsCRM/Sharepoint/File
CRMSharepointFileRequest Parameters:
NameParameterData TypeRequiredDescription
filenamebodystringNo
item_idbodystringNo
convert_to_pdfbodyboolNo
as_thumbnailbodyboolNo
is_developmentbodyboolNo
is_invoicebodyboolNo
is_tax_receiptbodyboolNo
CRMSharepointFileResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
file_base64formstringNo
filenameformstringNo
item_idformstringNo
filesizeformintNo
mimetypeformstringNo
sharepoint_urlformstringNo

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
}