Cochrane+ App API

<back to all web services

GetSalesTargetInfo

Requires Authentication
The following routes are available for this service:
GET/dashboard/salestargetinfo
"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;
}
export class GetSalesTargetInfoResponse extends ApiServiceResponse {
    /** @param {{totalMeetings?:number,averageTime?:string,averageQuality?:number,averageRating?:number,meetingsGoal?:number,averageQualityGoal?:number,averageTimeGoal?:string,averageRatingGoal?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    totalMeetings;
    /** @type {string} */
    averageTime;
    /** @type {number} */
    averageQuality;
    /** @type {number} */
    averageRating;
    /** @type {number} */
    meetingsGoal;
    /** @type {number} */
    averageQualityGoal;
    /** @type {string} */
    averageTimeGoal;
    /** @type {number} */
    averageRatingGoal;
}
export class GetSalesTargetInfo extends ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript GetSalesTargetInfo 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.

GET /dashboard/salestargetinfo HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	totalMeetings: 0,
	averageTime: String,
	averageQuality: 0,
	averageRating: 0,
	meetingsGoal: 0,
	averageQualityGoal: 0,
	averageTimeGoal: String,
	averageRatingGoal: 0,
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}