Antel API

<back to all web services

UserLogin

The following routes are available for this service:
POST/user/login
"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 StockOperatorData {
    /** @param {{id?:number,name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    name;
}
export class ClaimNumberRule {
    /** @param {{principalId?:number,channelName?:string,rulePattern?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    principalId;
    /** @type {string} */
    channelName;
    /** @type {string} */
    rulePattern;
}
export class LoginData {
    /** @param {{systemUserId?:number,refreshToken?:string,friendlyName?:string,vatValue?:number,canUplift?:boolean,stockCanDropOff?:boolean,stockCanCloseArrival?:boolean,blockUpliftIfLineCountDoesNotMatch?:boolean,blockUpliftIfQuantityDoesNotMatch?:boolean,canRipTip?:boolean,canDeleteUplifts?:boolean,stockOperators?:StockOperatorData[],claimNumberRules?:ClaimNumberRule[],upliftSyncInterval?:number,lateUpliftThreshold?:number,pauseUpliftReasons?:string[],noGoodsToUpliftReasons?:string[],blurryImageErrorScore?:number,blurryImageWarningScore?:number,blurryImageDetectionEnabled?:boolean,profileImageUrl?:string,claimValueWarningVariance?:number,stockCanVehicleAssignment?:boolean,stockCanOperatorAssignment?:boolean,stockCanStockEnd?:boolean,stockCanCheckSealDetails?:boolean,stockManualEnabled?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    systemUserId;
    /** @type {string} */
    refreshToken;
    /** @type {string} */
    friendlyName;
    /** @type {number} */
    vatValue;
    /** @type {boolean} */
    canUplift;
    /** @type {boolean} */
    stockCanDropOff;
    /** @type {boolean} */
    stockCanCloseArrival;
    /** @type {boolean} */
    blockUpliftIfLineCountDoesNotMatch;
    /** @type {boolean} */
    blockUpliftIfQuantityDoesNotMatch;
    /** @type {boolean} */
    canRipTip;
    /** @type {boolean} */
    canDeleteUplifts;
    /** @type {StockOperatorData[]} */
    stockOperators;
    /** @type {ClaimNumberRule[]} */
    claimNumberRules;
    /** @type {number} */
    upliftSyncInterval;
    /** @type {number} */
    lateUpliftThreshold;
    /** @type {string[]} */
    pauseUpliftReasons;
    /** @type {string[]} */
    noGoodsToUpliftReasons;
    /** @type {number} */
    blurryImageErrorScore;
    /** @type {number} */
    blurryImageWarningScore;
    /** @type {boolean} */
    blurryImageDetectionEnabled;
    /** @type {string} */
    profileImageUrl;
    /** @type {number} */
    claimValueWarningVariance;
    /** @type {boolean} */
    stockCanVehicleAssignment;
    /** @type {boolean} */
    stockCanOperatorAssignment;
    /** @type {boolean} */
    stockCanStockEnd;
    /** @type {boolean} */
    stockCanCheckSealDetails;
    /** @type {boolean} */
    stockManualEnabled;
}
export class UserLoginResponse extends ApiServiceResponse {
    /** @param {{data?:LoginData,description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {LoginData} */
    data;
}
export class UserLogin extends ApiServiceRequest {
    /** @param {{emailAddress?:string,password?:string,utcOffset?:number,pushPlayerId?:string,refreshToken?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    emailAddress;
    /** @type {string} */
    password;
    /** @type {number} */
    utcOffset;
    /**
     * @type {string}
     * @description The user's push token - used for push messages. */
    pushPlayerId;
    /**
     * @type {string}
     * @description Refresh token used to auto login the user. */
    refreshToken;
}

JavaScript UserLogin DTOs

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

HTTP + OTHER

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

POST /user/login HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"emailAddress":"String","password":"String","utcOffset":0,"pushPlayerId":"String","refreshToken":"String","apiKey":"String","latitude":0,"longitude":0}

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

{"data":{"systemUserId":0,"refreshToken":"String","friendlyName":"String","vatValue":0,"canUplift":false,"stockCanDropOff":false,"stockCanCloseArrival":false,"blockUpliftIfLineCountDoesNotMatch":false,"blockUpliftIfQuantityDoesNotMatch":false,"canRipTip":false,"canDeleteUplifts":false,"stockOperators":[{}],"claimNumberRules":[{}],"upliftSyncInterval":0,"lateUpliftThreshold":0,"pauseUpliftReasons":["String"],"noGoodsToUpliftReasons":["String"],"blurryImageErrorScore":0,"blurryImageWarningScore":0,"blurryImageDetectionEnabled":false,"profileImageUrl":"String","claimValueWarningVariance":0,"stockCanVehicleAssignment":false,"stockCanOperatorAssignment":false,"stockCanStockEnd":false,"stockCanCheckSealDetails":false,"stockManualEnabled":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"}}}