regis

<back to all web services

DirectoryImageUploadRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/directory/{uuid}/image/upload
"use strict";
export class DirectoryImageUploadRequest {
    /** @param {{file?:string,file_base64?:string,uuid?:string,contentType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    file;
    /** @type {string} */
    file_base64;
    /** @type {string} */
    uuid;
    /** @type {string} */
    contentType;
}

JavaScript DirectoryImageUploadRequest 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 /directory/{uuid}/image/upload HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	file: AA==,
	file_base64: String,
	uuid: String,
	contentType: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}