regis

<back to all web services

CatalogsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Catalogs
"use strict";
export class CatalogResponse {
    /** @param {{responseStatus?:ResponseStatus,id?:number,catalog_code?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    id;
    /** @type {string} */
    catalog_code;
}
export class CatalogsResponse {
    /** @param {{responseStatus?:ResponseStatus,catalogs?:CatalogResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {CatalogResponse[]} */
    catalogs;
}
export class CatalogsRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript CatalogsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Catalogs HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"catalogs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"catalog_code":"String"}]}