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

<back to all web services

SetPositionOnArea

Requires Authentication
The following routes are available for this service:
All Verbs/SetPositionOnArea/{Key}/{AreaName}/{Pixel}/{Width}
import 'package:servicestack/servicestack.dart';

class SetPositionOnArea implements IConvertible
{
    /**
    * Key identifying a location
    */
    // @ApiMember(Description="Key identifying a location", IsRequired=true)
    String? Key;

    /**
    * Area ID
    */
    // @ApiMember(Description="Area ID", IsRequired=true)
    String? AreaName;

    /**
    * Pixel number on the area
    */
    // @ApiMember(Description="Pixel number on the area", IsRequired=true)
    int? Pixel;

    /**
    * Pixel width
    */
    // @ApiMember(Description="Pixel width", IsRequired=true)
    int? Width;

    /**
    * Optional: name of the stockroom where the position is located
    */
    // @ApiMember(Description="Optional: name of the stockroom where the position is located")
    String? StockroomName;

    /**
    * 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")
    bool? Overwrite;

    SetPositionOnArea({this.Key,this.AreaName,this.Pixel,this.Width,this.StockroomName,this.Overwrite});
    SetPositionOnArea.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Key = json['Key'];
        AreaName = json['AreaName'];
        Pixel = json['Pixel'];
        Width = json['Width'];
        StockroomName = json['StockroomName'];
        Overwrite = json['Overwrite'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Key': Key,
        'AreaName': AreaName,
        'Pixel': Pixel,
        'Width': Width,
        'StockroomName': StockroomName,
        'Overwrite': Overwrite
    };

    getTypeName() => "SetPositionOnArea";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'clouddemo.pickeos.com', types: <String, TypeInfo> {
    'SetPositionOnArea': TypeInfo(TypeOf.Class, create:() => SetPositionOnArea()),
});

Dart SetPositionOnArea DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /SetPositionOnArea/{Key}/{AreaName}/{Pixel}/{Width} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SetPositionOnArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <AreaName>String</AreaName>
  <Key>String</Key>
  <Overwrite>false</Overwrite>
  <Pixel>0</Pixel>
  <StockroomName>String</StockroomName>
  <Width>0</Width>
</SetPositionOnArea>