Antel API

<back to all web services

UpliftAction

Requires Authentication
The following routes are available for this service:
POST/uplift/action
"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;
}
/** @typedef {number} */
export var UpliftScheduleAction;
(function (UpliftScheduleAction) {
    UpliftScheduleAction[UpliftScheduleAction["Confirm"] = 0] = "Confirm"
    UpliftScheduleAction[UpliftScheduleAction["Cancel"] = 1] = "Cancel"
})(UpliftScheduleAction || (UpliftScheduleAction = {}));
export class UpliftAction extends ApiServiceRequest {
    /** @param {{id?:number,action?:UpliftScheduleAction,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {UpliftScheduleAction} */
    action;
}

JavaScript UpliftAction 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 /uplift/action HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpliftAction 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>
  <Action>Confirm</Action>
  <Id>0</Id>
</UpliftAction>

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

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