Cochrane+ App API

<back to all web services

TemplateApprovalReview

Requires Authentication
The following routes are available for this service:
POST/template-approval/list
"use strict";
export class ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    apiKey;
    /**
     * @type {number}
     * @description Latitude of the user making this request */
    latitude;
    /**
     * @type {number}
     * @description Longitude of the user making this request */
    longitude;
}
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    description;
    /** @type {string} */
    heading;
    /** @type {boolean} */
    wasSuccessful;
    /** @type {Object} */
    modelState;
}
/** @typedef {number} */
export var TemplateApprovalStatus;
(function (TemplateApprovalStatus) {
    TemplateApprovalStatus[TemplateApprovalStatus["AwaitingApproval"] = 0] = "AwaitingApproval"
    TemplateApprovalStatus[TemplateApprovalStatus["Rejected"] = 1] = "Rejected"
    TemplateApprovalStatus[TemplateApprovalStatus["Approved"] = 2] = "Approved"
})(TemplateApprovalStatus || (TemplateApprovalStatus = {}));
export class TemplateApprovalReview extends ApiServiceRequest {
    /** @param {{templateApprovalId?:number,approvalStatus?:TemplateApprovalStatus,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    templateApprovalId;
    /** @type {TemplateApprovalStatus} */
    approvalStatus;
}

JavaScript TemplateApprovalReview 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 /template-approval/list HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	templateApprovalId: 0,
	approvalStatus: 0,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}