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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SetPositionOnArea:
    # @ApiMember(Description="Key identifying a location", IsRequired=true)
    key: Optional[str] = None
    """
    Key identifying a location
    """


    # @ApiMember(Description="Area ID", IsRequired=true)
    area_name: Optional[str] = None
    """
    Area ID
    """


    # @ApiMember(Description="Pixel number on the area", IsRequired=true)
    pixel: int = 0
    """
    Pixel number on the area
    """


    # @ApiMember(Description="Pixel width", IsRequired=true)
    width: int = 0
    """
    Pixel width
    """


    # @ApiMember(Description="Optional: name of the stockroom where the position is located")
    stockroom_name: Optional[str] = None
    """
    Optional: name of the stockroom where the position is located
    """


    # @ApiMember(Description="Optional: overwrite existing positions defined with the same key: Yes by default")
    overwrite: Optional[bool] = None
    """
    Optional: overwrite existing positions defined with the same key: Yes by default
    """

Python 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>