Antel API

<back to all web services

StartSaveUpliftProductImages

Requires Authentication
The following routes are available for this service:
POST/uplift/product/startimage
"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;
}
/** @typedef {number} */
export var UpliftImageType;
(function (UpliftImageType) {
    UpliftImageType[UpliftImageType["ClaimDoc"] = 0] = "ClaimDoc"
    UpliftImageType[UpliftImageType["DamagedOk"] = 1] = "DamagedOk"
    UpliftImageType[UpliftImageType["DamagedBad"] = 2] = "DamagedBad"
    UpliftImageType[UpliftImageType["Expired"] = 3] = "Expired"
    UpliftImageType[UpliftImageType["Recall"] = 4] = "Recall"
    UpliftImageType[UpliftImageType["Product"] = 5] = "Product"
    UpliftImageType[UpliftImageType["OperatorSignature"] = 6] = "OperatorSignature"
    UpliftImageType[UpliftImageType["OperatorRegistration"] = 7] = "OperatorRegistration"
    UpliftImageType[UpliftImageType["OutletSignature"] = 8] = "OutletSignature"
    UpliftImageType[UpliftImageType["GoodStock"] = 9] = "GoodStock"
    UpliftImageType[UpliftImageType["Deranged"] = 10] = "Deranged"
    UpliftImageType[UpliftImageType["Overstocked"] = 11] = "Overstocked"
    UpliftImageType[UpliftImageType["FactoryFault"] = 12] = "FactoryFault"
    UpliftImageType[UpliftImageType["Status"] = 13] = "Status"
})(UpliftImageType || (UpliftImageType = {}));
export class StartSaveUpliftProductImages extends ApiServiceRequest {
    /** @param {{type?:UpliftImageType,upliftId?:number,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {UpliftImageType} */
    type;
    /** @type {number} */
    upliftId;
}

JavaScript StartSaveUpliftProductImages DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /uplift/product/startimage HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"type":0,"upliftId":0,"apiKey":"String","latitude":0,"longitude":0}

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

{"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"}}}