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

<TemplateApprovalReview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <ApprovalStatus>AwaitingApproval</ApprovalStatus>
  <TemplateApprovalId>0</TemplateApprovalId>
</TemplateApprovalReview>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">
  <Description>String</Description>
  <Heading>String</Heading>
  <ModelState />
  <WasSuccessful>false</WasSuccessful>
</ApiServiceResponse>