Antel Merchandiser App API

GetScheduleRequest

The following routes are available for this service:
POST	/schedule/getschedule

import 'package:servicestack/servicestack.dart';

class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, IConvertible
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    String? ApiKey;

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    double? Latitude;

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    double? Longitude;

    ApiServiceRequest({this.ApiKey,this.Latitude,this.Longitude});
    ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        Latitude = JsonConverters.toDouble(json['Latitude']);
        Longitude = JsonConverters.toDouble(json['Longitude']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'Latitude': Latitude,
        'Longitude': Longitude
    };

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

class ApiServiceResponse implements IServiceResponse, IConvertible
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    String? Description;

    /**
    * Heading or summary of the response.
    */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    String? Heading;

    /**
    * Did the intended operation for this response complete successfully?
    */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    bool? WasSuccessful;

    ResponseStatus? ResponseStatus;

    ApiServiceResponse({this.Description,this.Heading,this.WasSuccessful,this.ResponseStatus});
    ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class ScheduleItems implements IConvertible
{
    String? OutletName;
    String? PrincipalName;
    String? ReferenceNumber;
    bool? IsSubmitted;

    ScheduleItems({this.OutletName,this.PrincipalName,this.ReferenceNumber,this.IsSubmitted});
    ScheduleItems.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        OutletName = json['OutletName'];
        PrincipalName = json['PrincipalName'];
        ReferenceNumber = json['ReferenceNumber'];
        IsSubmitted = json['IsSubmitted'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'OutletName': OutletName,
        'PrincipalName': PrincipalName,
        'ReferenceNumber': ReferenceNumber,
        'IsSubmitted': IsSubmitted
    };

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

class ScheduleDateItem implements IConvertible
{
    DateTime? Date;
    String? FormattedDateString;
    List<ScheduleItems>? ScheduleItems;

    ScheduleDateItem({this.Date,this.FormattedDateString,this.ScheduleItems});
    ScheduleDateItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Date = JsonConverters.fromJson(json['Date'],'DateTime',context!);
        FormattedDateString = json['FormattedDateString'];
        ScheduleItems = JsonConverters.fromJson(json['ScheduleItems'],'List<ScheduleItems>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Date': JsonConverters.toJson(Date,'DateTime',context!),
        'FormattedDateString': FormattedDateString,
        'ScheduleItems': JsonConverters.toJson(ScheduleItems,'List<ScheduleItems>',context!)
    };

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

class GetScheduleResponse extends ApiServiceResponse implements IConvertible
{
    List<ScheduleDateItem>? DateItems;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'DateItems': JsonConverters.toJson(DateItems,'List<ScheduleDateItem>',context!)
    });

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

class GetScheduleRequest extends ApiServiceRequest implements IConvertible
{
    DateTime? FromDate;
    DateTime? ToDate;

    GetScheduleRequest({this.FromDate,this.ToDate});
    GetScheduleRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'FromDate': JsonConverters.toJson(FromDate,'DateTime',context!),
        'ToDate': JsonConverters.toJson(ToDate,'DateTime',context!)
    });

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

TypeContext _ctx = TypeContext(library: 'returnit_api_dev.happen.zone', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'ScheduleItems': TypeInfo(TypeOf.Class, create:() => ScheduleItems()),
    'ScheduleDateItem': TypeInfo(TypeOf.Class, create:() => ScheduleDateItem()),
    'List<ScheduleItems>': TypeInfo(TypeOf.Class, create:() => <ScheduleItems>[]),
    'GetScheduleResponse': TypeInfo(TypeOf.Class, create:() => GetScheduleResponse()),
    'List<ScheduleDateItem>': TypeInfo(TypeOf.Class, create:() => <ScheduleDateItem>[]),
    'GetScheduleRequest': TypeInfo(TypeOf.Class, create:() => GetScheduleRequest()),
});

Dart GetScheduleRequest DTOs

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

HTTP + CSV

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

POST /schedule/getschedule HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FromDate":"0001-01-01T00:00:00.0000000","ToDate":"0001-01-01T00:00:00.0000000","ApiKey":"String","Latitude":0,"Longitude":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DateItems":[{}],"Description":"String","Heading":"String","WasSuccessful":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}