regis

<back to all web services

DirectoryImageRequest

Requires Authentication
Required permission:PicturePermission
The following routes are available for this service:
POST/directory/image
"use strict";
export class DirectoryImageRequest {
    /** @param {{directory_uuid?:string,uuid?:string,large?:boolean,medium?:boolean,original_size?:boolean,ignore_share?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    directory_uuid;
    /** @type {string} */
    uuid;
    /** @type {boolean} */
    large;
    /** @type {boolean} */
    medium;
    /** @type {boolean} */
    original_size;
    /** @type {boolean} */
    ignore_share;
}

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

<DirectoryImageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <directory_uuid>String</directory_uuid>
  <ignore_share>false</ignore_share>
  <large>false</large>
  <medium>false</medium>
  <original_size>false</original_size>
  <uuid>String</uuid>
</DirectoryImageRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

(byte[])