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

<back to all web services

PBL_ShowQuantity

Requires Authentication
The following routes are available for this service:
All Verbs/PBL_ShowQuantity
import 'package:servicestack/servicestack.dart';

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

    /**
    * Quantity: Number of LED to show
    */
    // @ApiMember(Description="Quantity: Number of LED to show", IsRequired=true)
    int? Quantity;

    /**
    * Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW
    */
    // @ApiMember(Description="Optional: Animated effect selection: 0 = Always ON (no effect, default), 1 = BLINK_NORMAL, 2 = BLINK_FAST, 3 = BLINK_SLOW, 4 = FADE_IN_OUT_NORMAL, 5 = FADE_IN_OUT_FAST, 6 = FADE_IN_OUT_SLOW, 7 = FADE_OUT_NORMAL, 8 = FADE_OUT_FAST, 9 = FADE_OUT_SLOW")
    int? Effect;

    /**
    * Optional: HTML Color code (e.g. FF00FF)
    */
    // @ApiMember(Description="Optional: HTML Color code (e.g. FF00FF)")
    String? Color;

    /**
    * Optional: When set to true, it turns off the same color in a previous position
    */
    // @ApiMember(Description="Optional: When set to true, it turns off the same color in a previous position")
    bool? HidePreviousPosition;

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

    PBL_ShowQuantity({this.Position,this.Quantity,this.Effect,this.Color,this.HidePreviousPosition,this.Owner});
    PBL_ShowQuantity.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Position = json['Position'];
        Quantity = json['Quantity'];
        Effect = json['Effect'];
        Color = json['Color'];
        HidePreviousPosition = json['HidePreviousPosition'];
        Owner = json['Owner'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Position': Position,
        'Quantity': Quantity,
        'Effect': Effect,
        'Color': Color,
        'HidePreviousPosition': HidePreviousPosition,
        'Owner': Owner
    };

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

class PBL_StandardResponse implements IConvertible
{
    bool? Success;
    String? Error;
    dynamic? Result;
    String? Color;

    PBL_StandardResponse({this.Success,this.Error,this.Result,this.Color});
    PBL_StandardResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Success = json['Success'];
        Error = json['Error'];
        Result = JsonConverters.fromJson(json['Result'],'dynamic',context!);
        Color = json['Color'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Success': Success,
        'Error': Error,
        'Result': JsonConverters.toJson(Result,'dynamic',context!),
        'Color': Color
    };

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

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

Dart PBL_ShowQuantity 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 /PBL_ShowQuantity HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PBL_ShowQuantity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Effect>0</Effect>
  <HidePreviousPosition>false</HidePreviousPosition>
  <Owner>String</Owner>
  <Position>String</Position>
  <Quantity>0</Quantity>
</PBL_ShowQuantity>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PBL_StandardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
  <Color>String</Color>
  <Error>String</Error>
  <Result />
  <Success>false</Success>
</PBL_StandardResponse>