digitaluapi

<back to all web services

SegmentsById

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/segments/{Id}
import 'package:servicestack/servicestack.dart';

class SegmentsByIdResponse implements IConvertible
{
    // @DataMember(Order=1)
    int? Id;

    // @DataMember(Order=6)
    ResponseStatus? ResponseStatus;

    SegmentsByIdResponse({this.Id,this.ResponseStatus});
    SegmentsByIdResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

// @DataContract
class SegmentsById implements IConvertible
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    int? Id;

    SegmentsById({this.Id});
    SegmentsById.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id
    };

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

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'SegmentsByIdResponse': TypeInfo(TypeOf.Class, create:() => SegmentsByIdResponse()),
    'SegmentsById': TypeInfo(TypeOf.Class, create:() => SegmentsById()),
});

Dart SegmentsById DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /segments/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}