Antel API

<back to all web services

UserLogin

The following routes are available for this service:
POST/user/login

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    /** @description Information about the response. */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public description: string;

    /** @description Heading or summary of the response. */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public heading: string;

    /** @description Did the intended operation for this response complete successfully? */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    public wasSuccessful: boolean;

    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class StockOperatorData
{
    public id: number;
    public name: string;

    public constructor(init?: Partial<StockOperatorData>) { (Object as any).assign(this, init); }
}

export class ClaimNumberRule
{
    public principalId: number;
    public channelName: string;
    public rulePattern: string;

    public constructor(init?: Partial<ClaimNumberRule>) { (Object as any).assign(this, init); }
}

export class LoginData
{
    public systemUserId: number;
    public refreshToken: string;
    public friendlyName: string;
    public vatValue: number;
    public canUplift: boolean;
    public stockCanDropOff: boolean;
    public stockCanCloseArrival: boolean;
    public blockUpliftIfLineCountDoesNotMatch: boolean;
    public blockUpliftIfQuantityDoesNotMatch: boolean;
    public canRipTip: boolean;
    public canDeleteUplifts: boolean;
    public stockOperators: StockOperatorData[];
    public claimNumberRules: ClaimNumberRule[];
    public upliftSyncInterval: number;
    public lateUpliftThreshold: number;
    public pauseUpliftReasons: string[];
    public noGoodsToUpliftReasons: string[];
    public blurryImageErrorScore: number;
    public blurryImageWarningScore: number;
    public blurryImageDetectionEnabled: boolean;
    public profileImageUrl: string;
    public claimValueWarningVariance: number;
    public stockCanVehicleAssignment: boolean;
    public stockCanOperatorAssignment: boolean;
    public stockCanStockEnd: boolean;
    public stockCanCheckSealDetails: boolean;
    public stockManualEnabled: boolean;

    public constructor(init?: Partial<LoginData>) { (Object as any).assign(this, init); }
}

export class UserLoginResponse extends ApiServiceResponse
{
    public data: LoginData;

    public constructor(init?: Partial<UserLoginResponse>) { super(init); (Object as any).assign(this, init); }
}

export class UserLogin extends ApiServiceRequest
{
    public emailAddress: string;
    public password: string;
    public utcOffset: number;
    /** @description The user's push token - used for push messages. */
    // @ApiMember(Description="The user's push token - used for push messages.")
    public pushPlayerId: string;

    /** @description Refresh token used to auto login the user. */
    // @ApiMember(Description="Refresh token used to auto login the user.")
    public refreshToken: string;

    public constructor(init?: Partial<UserLogin>) { super(init); (Object as any).assign(this, init); }
}

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