Antel API

UpliftAuthStatus

The following routes are available for this service:
GET	/uplift/auth


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 enum AuthStatusDataAuthStatus
{
    Pending = 0,
    Cancelled = 1,
    Authorised = 2,
}

export class AuthStatusData
{
    public status: AuthStatusDataAuthStatus;
    public upliftAuthRequestId: string;
    public found: boolean;

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

export class UpliftAuthStatusResponse extends ApiServiceResponse
{
    public upliftAuthStatuses: AuthStatusData[];

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

export class UpliftAuthStatus extends ApiServiceRequest
{
    public upliftAuthRequestIds: string[];

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

TypeScript UpliftAuthStatus 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.

GET /uplift/auth HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsv

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

{
	upliftAuthStatuses: 
	[
		{
			status: 0,
			found: 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
		}
	}
}