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

<back to all web services

SetPositions

Requires Authentication
The following routes are available for this service:
All Verbs/SetPositions
import Foundation
import ServiceStack

public class SetPositions : Codable
{
    /**
    * Key identifying a location
    */
    // @ApiMember(Description="Key identifying a location", IsRequired=true)
    public var positions:[Position] = []

    /**
    * Optional: name of the stockroom where the position is located
    */
    // @ApiMember(Description="Optional: name of the stockroom where the position is located")
    public var stockroomName:String

    /**
    * Optional: overwrite existing positions defined with the same key: Yes by default
    */
    // @ApiMember(Description="Optional: overwrite existing positions defined with the same key: Yes by default")
    public var overwrite:Bool?

    required public init(){}
}

public class Position : Codable
{
    public var id:Int
    public var key:String
    public var pixel:Int
    public var width:Int
    public var areaID:Int
    public var areaLabel:String
    public var label:String
    public var stockroomID:Int?

    required public init(){}
}


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

{
	Positions: 
	[
		{
			ID: 0,
			Key: String,
			Pixel: 0,
			Width: 0,
			AreaID: 0,
			AreaLabel: String,
			Label: String,
			StockroomID: 0
		}
	],
	StockroomName: String,
	Overwrite: False
}