Antel API

<back to all web services

SealDetailsRequest

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 FileDataItem
{
    public fileName: string;
    public fileUrl: string;
    public thumbnailUrl: string;
    public fileId: string;
    public thumbnailId: string;
    public linkId: number;
    public createdDate: string;

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

export class SealOrderHistoryItem
{
    public createdDate: string;
    public orderId: number;
    public orderNumber: string;
    public orderRequestingOperator: string;

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

export class SealMovementHistoryItem
{
    public id: number;
    public eventDateTime: string;
    public actionUserName: string;
    public scannedDepotName: string;
    public assignedBucketName: string;
    public assignedOrderNumber: string;
    public assignedOperatorName: string;
    public orderDriverName: string;
    public orderDriverCompanyName: string;
    public orderDriverLicensePlate: string;
    public targetWeight: number;
    public currentWeight: number;
    public hadWeightIssue: boolean;
    public hadUnknownUplift: boolean;
    public wasPaused: boolean;
    public pausedWasAwaitingAuth: boolean;

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

export class SealDetailsResponse extends ApiServiceResponse
{
    public principalName: string;
    public upliftNumber: string;
    public operatorName: string;
    public outletName: string;
    public upliftDate: string;
    public sealNumber: string;
    public currentWeight: string;
    public targetWeight: string;
    public hasWeightIssue: boolean;
    public bucketName: string;
    public claimNumbers: string[];
    public joinedClaimNumbers: string;
    public sealImages: FileDataItem[];
    public orderHistory: SealOrderHistoryItem[];
    public movementHistory: SealMovementHistoryItem[];

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

export class SealDetailsRequest extends ApiServiceRequest
{
    public sealId: number;

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

TypeScript SealDetailsRequest DTOs

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

{
	sealId: 0,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

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

{
	principalName: String,
	upliftNumber: String,
	operatorName: String,
	outletName: String,
	upliftDate: String,
	sealNumber: String,
	currentWeight: String,
	targetWeight: String,
	hasWeightIssue: False,
	bucketName: String,
	claimNumbers: 
	[
		String
	],
	joinedClaimNumbers: String,
	sealImages: 
	[
		{
			fileName: String,
			fileUrl: String,
			thumbnailUrl: String,
			linkId: 0,
			createdDate: 0001-01-01
		}
	],
	orderHistory: 
	[
		{
			createdDate: String,
			orderId: 0,
			orderNumber: String,
			orderRequestingOperator: String
		}
	],
	movementHistory: 
	[
		{
			id: 0,
			eventDateTime: String,
			actionUserName: String,
			scannedDepotName: String,
			assignedBucketName: String,
			assignedOrderNumber: String,
			assignedOperatorName: String,
			orderDriverName: String,
			orderDriverCompanyName: String,
			orderDriverLicensePlate: String,
			targetWeight: 0,
			currentWeight: 0,
			hadWeightIssue: False,
			hadUnknownUplift: False,
			wasPaused: False,
			pausedWasAwaitingAuth: 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
		}
	}
}