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

<back to all web services

ShowPredictiveEx

Requires Authentication
The following routes are available for this service:
All Verbs/ShowPredictiveEx/{BlinkKey}/{QtyBlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner}
import 'package:servicestack/servicestack.dart';

enum HeaderMode
{
    on,
    off,
    once,
}

class ShowPredictiveEx implements IConvertible
{
    /**
    * Key identifying a location that will be shown blinking
    */
    // @ApiMember(Description="Key identifying a location that will be shown blinking", IsRequired=true)
    String? BlinkKey;

    /**
    * Number of articles for blink 
    */
    // @ApiMember(Description="Number of articles for blink ", IsRequired=true)
    int? QtyBlinkKey;

    /**
    * Key identifying a location that will be shown not blinking
    */
    // @ApiMember(Description="Key identifying a location that will be shown not blinking", IsRequired=true)
    String? SteadyKey;

    /**
    * HTML Color code (e.g. FF00FF)
    */
    // @ApiMember(Description="HTML Color code (e.g. FF00FF)", IsRequired=true)
    String? Color;

    /**
    * Indicates the way the area header will be displayed (possible values are on, off, once)
    */
    // @ApiMember(Description="Indicates the way the area header will be displayed (possible values are on, off, once)", IsRequired=true)
    HeaderMode? ShowHeader;

    /**
    * Name of the owner of the color/command to allow color sharing
    */
    // @ApiMember(Description="Name of the owner of the color/command to allow color sharing", IsRequired=true)
    String? Owner;

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

    ShowPredictiveEx({this.BlinkKey,this.QtyBlinkKey,this.SteadyKey,this.Color,this.ShowHeader,this.Owner,this.StockroomName});
    ShowPredictiveEx.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BlinkKey = json['BlinkKey'];
        QtyBlinkKey = json['QtyBlinkKey'];
        SteadyKey = json['SteadyKey'];
        Color = json['Color'];
        ShowHeader = JsonConverters.fromJson(json['ShowHeader'],'HeaderMode',context!);
        Owner = json['Owner'];
        StockroomName = json['StockroomName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BlinkKey': BlinkKey,
        'QtyBlinkKey': QtyBlinkKey,
        'SteadyKey': SteadyKey,
        'Color': Color,
        'ShowHeader': JsonConverters.toJson(ShowHeader,'HeaderMode',context!),
        'Owner': Owner,
        'StockroomName': StockroomName
    };

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

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

Dart ShowPredictiveEx 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 /ShowPredictiveEx/{BlinkKey}/{QtyBlinkKey}/{SteadyKey}/{Color}/{ShowHeader}/{Owner} HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BlinkKey: String,
	QtyBlinkKey: 0,
	SteadyKey: String,
	Color: String,
	ShowHeader: on,
	Owner: String,
	StockroomName: String
}