| POST | /uplift/auth/cancel |
|---|
"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 AuthStatusDataAuthStatus;
(function (AuthStatusDataAuthStatus) {
AuthStatusDataAuthStatus[AuthStatusDataAuthStatus["Pending"] = 0] = "Pending"
AuthStatusDataAuthStatus[AuthStatusDataAuthStatus["Cancelled"] = 1] = "Cancelled"
AuthStatusDataAuthStatus[AuthStatusDataAuthStatus["Authorised"] = 2] = "Authorised"
})(AuthStatusDataAuthStatus || (AuthStatusDataAuthStatus = {}));
export class CancelUpliftAuthResponse extends ApiServiceResponse {
/** @param {{status?:AuthStatusDataAuthStatus,statusChanged?:boolean,description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {AuthStatusDataAuthStatus} */
status;
/** @type {boolean} */
statusChanged;
}
export class CancelUpliftAuth extends ApiServiceRequest {
/** @param {{upliftAuthRequestId?:string,reason?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
upliftAuthRequestId;
/** @type {string} */
reason;
}
JavaScript CancelUpliftAuth DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/auth/cancel HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
reason: String,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
status: 0,
statusChanged: False,
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
}
}
}