Antel Merchandiser App API

<back to all web services

IncompleteUpliftRequestList

The following routes are available for this service:
GET/sync/incompleteupliftrequests
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 IncompleteUpliftRequestData implements IConvertible
{
    int? SystemUserId;
    String? IncompleteUpliftRequestId;
    String? UpliftRequestOnDeviceId;
    int? OutletId;
    DateTime? LastSynced;
    bool? IsSubmitted;
    bool? DeleteFromDevice;
    String? CreatedByMerchandiserName;

    IncompleteUpliftRequestData({this.SystemUserId,this.IncompleteUpliftRequestId,this.UpliftRequestOnDeviceId,this.OutletId,this.LastSynced,this.IsSubmitted,this.DeleteFromDevice,this.CreatedByMerchandiserName});
    IncompleteUpliftRequestData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SystemUserId = json['SystemUserId'];
        IncompleteUpliftRequestId = json['IncompleteUpliftRequestId'];
        UpliftRequestOnDeviceId = json['UpliftRequestOnDeviceId'];
        OutletId = json['OutletId'];
        LastSynced = JsonConverters.fromJson(json['LastSynced'],'DateTime',context!);
        IsSubmitted = json['IsSubmitted'];
        DeleteFromDevice = json['DeleteFromDevice'];
        CreatedByMerchandiserName = json['CreatedByMerchandiserName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SystemUserId': SystemUserId,
        'IncompleteUpliftRequestId': IncompleteUpliftRequestId,
        'UpliftRequestOnDeviceId': UpliftRequestOnDeviceId,
        'OutletId': OutletId,
        'LastSynced': JsonConverters.toJson(LastSynced,'DateTime',context!),
        'IsSubmitted': IsSubmitted,
        'DeleteFromDevice': DeleteFromDevice,
        'CreatedByMerchandiserName': CreatedByMerchandiserName
    };

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

class OutletRegionData implements IConvertible
{
    int? PrincipalId;
    String? Region;

    OutletRegionData({this.PrincipalId,this.Region});
    OutletRegionData.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class OutletData implements IConvertible
{
    int? Id;
    String? Name;
    String? LastRequestedDate;
    bool? HasGeneralUpliftRequest;
    int? UpliftRequestCount;
    List<int>? AssignedPrincipalIds;
    List<OutletRegionData>? AssignedRegions;
    String? Channel;
    String? NextScheduledDate;

    OutletData({this.Id,this.Name,this.LastRequestedDate,this.HasGeneralUpliftRequest,this.UpliftRequestCount,this.AssignedPrincipalIds,this.AssignedRegions,this.Channel,this.NextScheduledDate});
    OutletData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        LastRequestedDate = json['LastRequestedDate'];
        HasGeneralUpliftRequest = json['HasGeneralUpliftRequest'];
        UpliftRequestCount = json['UpliftRequestCount'];
        AssignedPrincipalIds = JsonConverters.fromJson(json['AssignedPrincipalIds'],'List<int>',context!);
        AssignedRegions = JsonConverters.fromJson(json['AssignedRegions'],'List<OutletRegionData>',context!);
        Channel = json['Channel'];
        NextScheduledDate = json['NextScheduledDate'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'LastRequestedDate': LastRequestedDate,
        'HasGeneralUpliftRequest': HasGeneralUpliftRequest,
        'UpliftRequestCount': UpliftRequestCount,
        'AssignedPrincipalIds': JsonConverters.toJson(AssignedPrincipalIds,'List<int>',context!),
        'AssignedRegions': JsonConverters.toJson(AssignedRegions,'List<OutletRegionData>',context!),
        'Channel': Channel,
        'NextScheduledDate': NextScheduledDate
    };

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

class IncompleteUpliftRequestListResponse extends ApiServiceResponse implements IConvertible
{
    List<IncompleteUpliftRequestData>? IncompleteUpliftRequests;
    bool? AllowLogin;
    List<OutletData>? AssignedOutlets;
    bool? Archived;

    IncompleteUpliftRequestListResponse({this.IncompleteUpliftRequests,this.AllowLogin,this.AssignedOutlets,this.Archived});
    IncompleteUpliftRequestListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        IncompleteUpliftRequests = JsonConverters.fromJson(json['IncompleteUpliftRequests'],'List<IncompleteUpliftRequestData>',context!);
        AllowLogin = json['AllowLogin'];
        AssignedOutlets = JsonConverters.fromJson(json['AssignedOutlets'],'List<OutletData>',context!);
        Archived = json['Archived'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'IncompleteUpliftRequests': JsonConverters.toJson(IncompleteUpliftRequests,'List<IncompleteUpliftRequestData>',context!),
        'AllowLogin': AllowLogin,
        'AssignedOutlets': JsonConverters.toJson(AssignedOutlets,'List<OutletData>',context!),
        'Archived': Archived
    });

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

class IncompleteUpliftRequestList extends ApiServiceRequest implements IConvertible
{
    IncompleteUpliftRequestList();
    IncompleteUpliftRequestList.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "IncompleteUpliftRequestList";
    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()),
    'IncompleteUpliftRequestData': TypeInfo(TypeOf.Class, create:() => IncompleteUpliftRequestData()),
    'OutletRegionData': TypeInfo(TypeOf.Class, create:() => OutletRegionData()),
    'OutletData': TypeInfo(TypeOf.Class, create:() => OutletData()),
    'List<OutletRegionData>': TypeInfo(TypeOf.Class, create:() => <OutletRegionData>[]),
    'IncompleteUpliftRequestListResponse': TypeInfo(TypeOf.Class, create:() => IncompleteUpliftRequestListResponse()),
    'List<IncompleteUpliftRequestData>': TypeInfo(TypeOf.Class, create:() => <IncompleteUpliftRequestData>[]),
    'List<OutletData>': TypeInfo(TypeOf.Class, create:() => <OutletData>[]),
    'IncompleteUpliftRequestList': TypeInfo(TypeOf.Class, create:() => IncompleteUpliftRequestList()),
});

Dart IncompleteUpliftRequestList 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.

GET /sync/incompleteupliftrequests HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IncompleteUpliftRequests: 
	[
		{
			
		}
	],
	AllowLogin: False,
	AssignedOutlets: 
	[
		{
			
		}
	],
	Archived: False,
	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
		}
	}
}