Antel API

<back to all web services

SealDetailsRequest

Requires Authentication
The following routes are available for this service:
POST/stock/seal/details
namespace WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        ///<summary>
        ///Information about the response.
        ///</summary>
        [<ApiMember(Description="Information about the response.", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
        member val Heading:String = null with get,set

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
        member val WasSuccessful:Boolean = new Boolean() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FileDataItem() = 
        member val FileName:String = null with get,set
        member val FileUrl:String = null with get,set
        member val ThumbnailUrl:String = null with get,set
        member val FileId:Guid = new Guid() with get,set
        member val ThumbnailId:Guid = new Guid() with get,set
        member val LinkId:Int32 = new Int32() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type SealOrderHistoryItem() = 
        member val CreatedDate:String = null with get,set
        member val OrderId:Int32 = new Int32() with get,set
        member val OrderNumber:String = null with get,set
        member val OrderRequestingOperator:String = null with get,set

    [<AllowNullLiteral>]
    type SealMovementHistoryItem() = 
        member val Id:Int64 = new Int64() with get,set
        member val EventDateTime:String = null with get,set
        member val ActionUserName:String = null with get,set
        member val ScannedDepotName:String = null with get,set
        member val AssignedBucketName:String = null with get,set
        member val AssignedOrderNumber:String = null with get,set
        member val AssignedOperatorName:String = null with get,set
        member val OrderDriverName:String = null with get,set
        member val OrderDriverCompanyName:String = null with get,set
        member val OrderDriverLicensePlate:String = null with get,set
        member val TargetWeight:Double = new Double() with get,set
        member val CurrentWeight:Double = new Double() with get,set
        member val HadWeightIssue:Boolean = new Boolean() with get,set
        member val HadUnknownUplift:Boolean = new Boolean() with get,set
        member val WasPaused:Boolean = new Boolean() with get,set
        member val PausedWasAwaitingAuth:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SealDetailsResponse() = 
        inherit ApiServiceResponse()
        member val PrincipalName:String = null with get,set
        member val UpliftNumber:String = null with get,set
        member val OperatorName:String = null with get,set
        member val OutletName:String = null with get,set
        member val UpliftDate:String = null with get,set
        member val SealNumber:String = null with get,set
        member val CurrentWeight:String = null with get,set
        member val TargetWeight:String = null with get,set
        member val HasWeightIssue:Boolean = new Boolean() with get,set
        member val BucketName:String = null with get,set
        member val ClaimNumbers:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val JoinedClaimNumbers:String = null with get,set
        member val SealImages:ResizeArray<FileDataItem> = new ResizeArray<FileDataItem>() with get,set
        member val OrderHistory:ResizeArray<SealOrderHistoryItem> = new ResizeArray<SealOrderHistoryItem>() with get,set
        member val MovementHistory:ResizeArray<SealMovementHistoryItem> = new ResizeArray<SealMovementHistoryItem>() with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Latitude of the user making this request")>]
        member val Latitude:Double = new Double() with get,set

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [<ApiMember(DataType="double", Description="Longitude of the user making this request")>]
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type SealDetailsRequest() = 
        inherit ApiServiceRequest()
        member val SealId:Int32 = new Int32() with get,set

F# SealDetailsRequest 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 /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
		}
	}
}