Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

MissionsPush

Requires Authentication
The following routes are available for this service:
All Verbs/MissionsPush
namespace GoToLightAPI

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

    [<AllowNullLiteral>]
    type Position() = 
        member val ID:Int32 = new Int32() with get,set
        member val Key:String = null with get,set
        member val Pixel:Int32 = new Int32() with get,set
        member val Width:Int32 = new Int32() with get,set
        member val AreaID:Int32 = new Int32() with get,set
        member val AreaLabel:String = null with get,set
        member val Label:String = null with get,set
        member val StockroomID:Nullable<Int64> = new Nullable<Int64>() with get,set

    [<AllowNullLiteral>]
    type TraceabilityMissionDetail() = 
        member val IDMissionDetail:Int32 = new Int32() with get,set
        member val PreparedQuantity:Double = new Double() with get,set
        member val Batch:String = null with get,set
        member val ContainerID:Int32 = new Int32() with get,set
        member val ContainerName:String = null with get,set
        member val ContainerSizeXCm:Double = new Double() with get,set
        member val ContainerSizeYCm:Double = new Double() with get,set
        member val ContainerSizeZCm:Double = new Double() with get,set
        member val ContainerWeight:Double = new Double() with get,set
        member val StockroomID:Int32 = new Int32() with get,set
        member val StockroomName:String = null with get,set
        member val Operator:String = null with get,set
        member val VersionSelected:String = null with get,set

    [<AllowNullLiteral>]
    type TraceabilityMissionDetailPacking() = 
        member val IDMissionDetail:Int32 = new Int32() with get,set
        member val PreparedQuantity:Double = new Double() with get,set
        member val Batch:String = null with get,set
        member val ContainerID:Int32 = new Int32() with get,set
        member val ContainerName:String = null with get,set
        member val ContainerSizeXCm:Double = new Double() with get,set
        member val ContainerSizeYCm:Double = new Double() with get,set
        member val ContainerSizeZCm:Double = new Double() with get,set
        member val ContainerWeight:Double = new Double() with get,set
        member val StockroomID:Int32 = new Int32() with get,set
        member val StockroomName:String = null with get,set
        member val Operator:String = null with get,set
        member val VersionSelected:String = null with get,set

    [<AllowNullLiteral>]
    type Container() = 
        member val ContainerID:Int32 = new Int32() with get,set
        member val ContainerCode:String = null with get,set
        member val Location:String = null with get,set
        member val DimensionX:Object = null with get,set
        member val DimensionY:Object = null with get,set
        member val DimensionZ:Object = null with get,set
        member val Deleted:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type StockAdditional() = 
        member val StockID:Int32 = new Int32() with get,set
        member val Gtin:String = null with get,set
        member val StockLocation:String = null with get,set
        member val PhysicalQuantityStockLocation:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type Stock() = 
        member val StockID:Int32 = new Int32() with get,set
        member val ProductID:String = null with get,set
        member val ProductAttributeID:String = null with get,set
        member val Reference:String = null with get,set
        member val Gtin:String = null with get,set
        member val GtinAttribute:String = null with get,set
        member val Label:String = null with get,set
        member val StockLocation:String = null with get,set
        member val PhysicalQuantityStockLocation:Double = new Double() with get,set
        member val ReserveStockLocation:String = null with get,set
        member val PhysicalQuantityReserveStockLocation:Double = new Double() with get,set
        member val NbSKUInPackage:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PackageReference:String = null with get,set
        member val NbSKUInPackage2:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PackageReference2:String = null with get,set
        member val Weight:String = null with get,set
        member val FillInBatchNumber:Boolean = new Boolean() with get,set
        member val FillInDate:Boolean = new Boolean() with get,set
        member val PictureURL:String = null with get,set
        member val StockAdditionals:ResizeArray<StockAdditional> = null with get,set
        member val SearchKey:String = null with get,set

    [<AllowNullLiteral>]
    type MissionDetailComment() = 
        member val ID:Int32 = new Int32() with get,set
        member val MissionDetailID:Int32 = new Int32() with get,set
        member val Comment:String = null with get,set
        member val Timestamp:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Operator:String = null with get,set

    [<AllowNullLiteral>]
    type MissionDetail() = 
        member val ID:Int32 = new Int32() with get,set
        member val MissionID:Int32 = new Int32() with get,set
        member val Label:String = null with get,set
        member val Reference:String = null with get,set
        member val Quantity:Nullable<Double> = new Nullable<Double>() with get,set
        member val PreparedQuantity:Nullable<Double> = new Nullable<Double>() with get,set
        member val PackedQuantity:Double = new Double() with get,set
        member val Positions:ResizeArray<Position> = null with get,set
        member val Tray:String = null with get,set
        member val StockLocation:String = null with get,set
        member val LineNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Info:String = null with get,set
        member val GTIN:String = null with get,set
        member val SupplierReference:String = null with get,set
        member val PickingIndex:Int32 = new Int32() with get,set
        member val TraceabilityDetails:ResizeArray<TraceabilityMissionDetail> = null with get,set
        member val TraceabilityDetailsPacking:ResizeArray<TraceabilityMissionDetailPacking> = null with get,set
        member val Substitutable:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val SubstitutionRef:String = null with get,set
        member val TraceabilityBatch:String = null with get,set
        member val Data1:String = null with get,set
        member val Data2:String = null with get,set
        member val Data3:String = null with get,set
        member val Data4:String = null with get,set
        member val Data5:String = null with get,set
        member val Data6:String = null with get,set
        member val Data7:String = null with get,set
        member val Data8:String = null with get,set
        member val Data9:String = null with get,set
        member val Data10:String = null with get,set
        member val Data11:String = null with get,set
        member val Data12:String = null with get,set
        member val PackageReference:String = null with get,set
        member val NbSKUInPackage:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val PackageReference2:String = null with get,set
        member val NbSKUInPackage2:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val ContainerID:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val Container:Container = null with get,set
        member val WeightPerItemInKg:Nullable<Single> = new Nullable<Single>() with get,set
        member val VolumePerItemInM3:Nullable<Single> = new Nullable<Single>() with get,set
        member val PictureURL:String = null with get,set
        member val Stock:Stock = null with get,set
        member val QuantityUnit:String = null with get,set
        member val Comments:MissionDetailComment = null with get,set
        member val ShortageQuantity:Nullable<Double> = new Nullable<Double>() with get,set
        member val ItemPreparationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreationDateTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val QuantityDispatched:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val Versions:ResizeArray<String> = null with get,set
        member val QuantityBreakage:Int32 = new Int32() with get,set
        member val IsProductCritical:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Owner:String = null with get,set
        member val StockroomID:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type Work() = 
        member val WorkID:Int32 = new Int32() with get,set
        member val MissionID:Int32 = new Int32() with get,set
        member val Owner:String = null with get,set
        member val Duration:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val DateBegin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DateEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    type MissionState =
        | New = 0
        | PickingStarted = 1
        | PickingFinished = 2
        | PickingManuallyValidated = 3
        | RamasseFinished = 4
        | PackingFinished = 5

    [<AllowNullLiteral>]
    type ShippingDetails() = 
        member val MissionID:Int32 = new Int32() with get,set
        member val ShippingWeight:Double = new Double() with get,set
        member val ShippingHeight:Double = new Double() with get,set
        member val ShippingLenght:Double = new Double() with get,set
        member val ShippingWidth:Double = new Double() with get,set
        member val ShippingCompany:String = null with get,set
        member val ShippingLastname:String = null with get,set
        member val ShippingFirstname:String = null with get,set
        member val ShippingAddress1:String = null with get,set
        member val ShippingAddress2:String = null with get,set
        member val ShippingAddress3:String = null with get,set
        member val ShippingPostcode:String = null with get,set
        member val ShippingCountry:String = null with get,set
        member val ShippingCity:String = null with get,set
        member val ShippingOther:String = null with get,set
        member val ShippingPhone:String = null with get,set
        member val ShippingMobilePhone:String = null with get,set
        member val ShippingMail:String = null with get,set
        member val CarrierName:String = null with get,set
        member val CarrierProductCode:String = null with get,set
        member val CarrierTrackingNumber:String = null with get,set

    [<AllowNullLiteral>]
    type Mission() = 
        member val ID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Info:String = null with get,set
        member val DeleteWhenComplete:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DateBegin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DateEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Owner:String = null with get,set
        member val FinderKey:String = null with get,set
        member val Details:ResizeArray<MissionDetail> = null with get,set
        member val Containers:ResizeArray<Container> = null with get,set
        member val Works:ResizeArray<Work> = null with get,set
        member val Type:String = null with get,set
        member val Trolley:String = null with get,set
        member val Printer:String = null with get,set
        member val Cancelled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Blocked:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val MissionModification:String = null with get,set
        member val Carrier:String = null with get,set
        member val BatchId:String = null with get,set
        member val State:MissionState = new MissionState() with get,set
        member val RelatedContainersFromOtherMissions:ResizeArray<Container> = null with get,set
        member val TotalQuantity:Single = new Single() with get,set
        member val TotalQuantityPrepared:Single = new Single() with get,set
        member val TotalQuantityDispatched:Single = new Single() with get,set
        member val TotalQuantityPacked:Single = new Single() with get,set
        member val GenericData1:String = null with get,set
        member val GenericData2:String = null with get,set
        member val GenericData3:String = null with get,set
        member val Message:String = null with get,set
        member val TransportLabelPrinted:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val OutputFileGenerated:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ShippingDetails:ShippingDetails = null with get,set
        member val ConnectorOrigin:String = null with get,set
        member val DispatchAnomalyTempTray:String = null with get,set

    [<AllowNullLiteral>]
    type MissionsPush() = 
        ///<summary>
        ///List of missions to push
        ///</summary>
        [<ApiMember(Description="List of missions to push", IsRequired=true)>]
        member val Missions:ResizeArray<Mission> = null with get,set

F# MissionsPush 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 /MissionsPush HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Missions: 
	[
		{
			ID: 0,
			Name: String,
			Info: String,
			DeleteWhenComplete: False,
			DateBegin: 0001-01-01,
			DateEnd: 0001-01-01,
			Owner: String,
			FinderKey: String,
			Details: 
			[
				{
					ID: 0,
					MissionID: 0,
					Label: String,
					Reference: String,
					Quantity: 0,
					PreparedQuantity: 0,
					PackedQuantity: 0,
					Positions: 
					[
						{
							ID: 0,
							Key: String,
							Pixel: 0,
							Width: 0,
							AreaID: 0,
							AreaLabel: String,
							Label: String,
							StockroomID: 0
						}
					],
					Tray: String,
					StockLocation: String,
					LineNumber: 0,
					Info: String,
					GTIN: String,
					SupplierReference: String,
					PickingIndex: 0,
					TraceabilityDetails: 
					[
						{
							IDMissionDetail: 0,
							PreparedQuantity: 0,
							Batch: String,
							ContainerID: 0,
							ContainerName: String,
							ContainerSizeXCm: 0,
							ContainerSizeYCm: 0,
							ContainerSizeZCm: 0,
							ContainerWeight: 0,
							StockroomID: 0,
							StockroomName: String,
							Operator: String,
							VersionSelected: String
						}
					],
					TraceabilityDetailsPacking: 
					[
						{
							IDMissionDetail: 0,
							PreparedQuantity: 0,
							Batch: String,
							ContainerID: 0,
							ContainerName: String,
							ContainerSizeXCm: 0,
							ContainerSizeYCm: 0,
							ContainerSizeZCm: 0,
							ContainerWeight: 0,
							StockroomID: 0,
							StockroomName: String,
							Operator: String,
							VersionSelected: String
						}
					],
					Substitutable: False,
					SubstitutionRef: String,
					TraceabilityBatch: String,
					Data1: String,
					Data2: String,
					Data3: String,
					Data4: String,
					Data5: String,
					Data6: String,
					Data7: String,
					Data8: String,
					Data9: String,
					Data10: String,
					Data11: String,
					Data12: String,
					PackageReference: String,
					NbSKUInPackage: 0,
					PackageReference2: String,
					NbSKUInPackage2: 0,
					ContainerID: 0,
					Container: 
					{
						ContainerID: 0,
						ContainerCode: String,
						Location: String,
						DimensionX: {},
						DimensionY: {},
						DimensionZ: {},
						Deleted: False
					},
					WeightPerItemInKg: 0,
					VolumePerItemInM3: 0,
					PictureURL: String,
					Stock: 
					{
						StockID: 0,
						ProductID: String,
						ProductAttributeID: String,
						Reference: String,
						Gtin: String,
						GtinAttribute: String,
						Label: String,
						StockLocation: String,
						PhysicalQuantityStockLocation: 0,
						ReserveStockLocation: String,
						PhysicalQuantityReserveStockLocation: 0,
						NbSKUInPackage: 0,
						PackageReference: String,
						NbSKUInPackage2: 0,
						PackageReference2: String,
						Weight: String,
						FillInBatchNumber: False,
						FillInDate: False,
						PictureURL: String,
						StockAdditionals: 
						[
							{
								StockID: 0,
								Gtin: String,
								StockLocation: String,
								PhysicalQuantityStockLocation: 0
							}
						],
						SearchKey: String-String-String-String-String
					},
					QuantityUnit: String,
					Comments: 
					{
						ID: 0,
						MissionDetailID: 0,
						Comment: String,
						Timestamp: 0001-01-01,
						Operator: String
					},
					ShortageQuantity: 0,
					ItemPreparationDate: 0001-01-01,
					CreationDateTime: 0001-01-01,
					QuantityDispatched: 0,
					Versions: 
					[
						String
					],
					QuantityBreakage: 0,
					IsProductCritical: False,
					Owner: String,
					StockroomID: 0
				}
			],
			Containers: 
			[
				{
					ContainerID: 0,
					ContainerCode: String,
					Location: String,
					DimensionX: {},
					DimensionY: {},
					DimensionZ: {},
					Deleted: False
				}
			],
			Works: 
			[
				{
					WorkID: 0,
					MissionID: 0,
					Owner: String,
					Duration: PT0S,
					DateBegin: 0001-01-01,
					DateEnd: 0001-01-01
				}
			],
			Type: String,
			Trolley: String,
			Printer: String,
			Cancelled: False,
			Blocked: False,
			MissionModification: String,
			Carrier: String,
			BatchId: String,
			State: New,
			RelatedContainersFromOtherMissions: 
			[
				{
					ContainerID: 0,
					ContainerCode: String,
					Location: String,
					DimensionX: {},
					DimensionY: {},
					DimensionZ: {},
					Deleted: False
				}
			],
			TotalQuantity: 0,
			TotalQuantityPrepared: 0,
			TotalQuantityDispatched: 0,
			TotalQuantityPacked: 0,
			GenericData1: String,
			GenericData2: String,
			GenericData3: String,
			Message: String,
			TransportLabelPrinted: False,
			OutputFileGenerated: False,
			ShippingDetails: 
			{
				MissionID: 0,
				ShippingWeight: 0,
				ShippingHeight: 0,
				ShippingLenght: 0,
				ShippingWidth: 0,
				ShippingCompany: String,
				ShippingLastname: String,
				ShippingFirstname: String,
				ShippingAddress1: String,
				ShippingAddress2: String,
				ShippingAddress3: String,
				ShippingPostcode: String,
				ShippingCountry: String,
				ShippingCity: String,
				ShippingOther: String,
				ShippingPhone: String,
				ShippingMobilePhone: String,
				ShippingMail: String,
				CarrierName: String,
				CarrierProductCode: String,
				CarrierTrackingNumber: String
			},
			ConnectorOrigin: String,
			DispatchAnomalyTempTray: String
		}
	]
}