Cochrane+ App API

<back to all web services

GetSalesTargetInfo

Requires Authentication
The following routes are available for this service:
GET/dashboard/salestargetinfo

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public description: string;
    public heading: string;
    public wasSuccessful: boolean;
    public modelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class GetSalesTargetInfoResponse extends ApiServiceResponse
{
    public totalMeetings: number;
    public averageTime: string;
    public averageQuality: number;
    public averageRating: number;
    public meetingsGoal: number;
    public averageQualityGoal: number;
    public averageTimeGoal: string;
    public averageRatingGoal: number;

    public constructor(init?: Partial<GetSalesTargetInfoResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetSalesTargetInfo extends ApiServiceRequest
{

    public constructor(init?: Partial<GetSalesTargetInfo>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetSalesTargetInfo DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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":{}}