Antel API

<back to all web services

AutoLogin


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 AutoLoginResponse extends ApiServiceResponse
{
    public data: LoginData;

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

export class AutoLogin extends ApiServiceRequest
{
    public systemUserId: number;
    public refreshToken: string;
    public utcOffset: number;

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

TypeScript AutoLogin DTOs

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

HTTP + JSV

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

POST /jsv/reply/AutoLogin HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	systemUserId: 0,
	refreshToken: String,
	utcOffset: 0,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}