Antel API

UpliftHistory

The following routes are available for this service:
GET	/uplift/history

"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,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Information about the response. */
    description;
    /**
     * @type {string}
     * @description Heading or summary of the response. */
    heading;
    /**
     * @type {boolean}
     * @description Did the intended operation for this response complete successfully? */
    wasSuccessful;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class UpliftHistoryItem {
    /** @param {{principleLogo?:string,principleName?:string,outletName?:string,appointmentDate?:string,appointmentDateFormatted?:string,submittedDate?:string,submittedDateFormatted?:string,upliftNumber?:string,submissionDocument?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    principleLogo;
    /** @type {string} */
    principleName;
    /** @type {string} */
    outletName;
    /** @type {string} */
    appointmentDate;
    /** @type {string} */
    appointmentDateFormatted;
    /** @type {string} */
    submittedDate;
    /** @type {string} */
    submittedDateFormatted;
    /** @type {string} */
    upliftNumber;
    /** @type {string} */
    submissionDocument;
}
export class UpliftHistoryResponse extends ApiServiceResponse {
    /** @param {{upliftHistoryItems?:UpliftHistoryItem[],description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {UpliftHistoryItem[]} */
    upliftHistoryItems;
}
export class UpliftHistory extends ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript UpliftHistory 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 /uplift/history HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"upliftHistoryItems":[{}],"description":"String","heading":"String","wasSuccessful":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}