Antel API

<back to all web services

SealDetailsRequest

import java.math.*
import java.util.*
import net.servicestack.client.*


open class SealDetailsRequest : ApiServiceRequest()
{
    var sealId:Int? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var apiKey:String? = null

    /**
    * Latitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Latitude of the user making this request")
    var latitude:Double? = null

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var longitude:Double? = null
}

open class SealDetailsResponse : ApiServiceResponse()
{
    var principalName:String? = null
    var upliftNumber:String? = null
    var operatorName:String? = null
    var outletName:String? = null
    var upliftDate:String? = null
    var sealNumber:String? = null
    var currentWeight:String? = null
    var targetWeight:String? = null
    var hasWeightIssue:Boolean? = null
    var bucketName:String? = null
    var claimNumbers:ArrayList<String> = ArrayList<String>()
    var joinedClaimNumbers:String? = null
    var sealImages:ArrayList<FileDataItem> = ArrayList<FileDataItem>()
    var orderHistory:ArrayList<SealOrderHistoryItem> = ArrayList<SealOrderHistoryItem>()
    var movementHistory:ArrayList<SealMovementHistoryItem> = ArrayList<SealMovementHistoryItem>()
}

open class ApiServiceResponse : IServiceResponse
{
    /**
    * Information about the response.
    */
    @ApiMember(Description="Information about the response.", IsRequired=true)
    var description:String? = null

    /**
    * Heading or summary of the response.
    */
    @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    var heading:String? = null

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

    var responseStatus:ResponseStatus? = null
}

open class FileDataItem
{
    var fileName:String? = null
    var fileUrl:String? = null
    var thumbnailUrl:String? = null
    var fileId:UUID? = null
    var thumbnailId:UUID? = null
    var linkId:Int? = null
    var createdDate:Date? = null
}

open class SealOrderHistoryItem
{
    var createdDate:String? = null
    var orderId:Int? = null
    var orderNumber:String? = null
    var orderRequestingOperator:String? = null
}

open class SealMovementHistoryItem
{
    var id:Long? = null
    var eventDateTime:String? = null
    var actionUserName:String? = null
    var scannedDepotName:String? = null
    var assignedBucketName:String? = null
    var assignedOrderNumber:String? = null
    var assignedOperatorName:String? = null
    var orderDriverName:String? = null
    var orderDriverCompanyName:String? = null
    var orderDriverLicensePlate:String? = null
    var targetWeight:Double? = null
    var currentWeight:Double? = null
    var hadWeightIssue:Boolean? = null
    var hadUnknownUplift:Boolean? = null
    var wasPaused:Boolean? = null
    var pausedWasAwaitingAuth:Boolean? = null
}

Kotlin 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
		}
	}
}