Antel API

<back to all web services

StartSaveUpliftProductImages

Requires Authentication
The following routes are available for this service:
POST/uplift/product/startimage
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 UpliftImageType
{
    static const UpliftImageType ClaimDoc = const UpliftImageType._(0);
    static const UpliftImageType DamagedOk = const UpliftImageType._(1);
    static const UpliftImageType DamagedBad = const UpliftImageType._(2);
    static const UpliftImageType Expired = const UpliftImageType._(3);
    static const UpliftImageType Recall = const UpliftImageType._(4);
    static const UpliftImageType Product = const UpliftImageType._(5);
    static const UpliftImageType OperatorSignature = const UpliftImageType._(6);
    static const UpliftImageType OperatorRegistration = const UpliftImageType._(7);
    static const UpliftImageType OutletSignature = const UpliftImageType._(8);
    static const UpliftImageType GoodStock = const UpliftImageType._(9);
    static const UpliftImageType Deranged = const UpliftImageType._(10);
    static const UpliftImageType Overstocked = const UpliftImageType._(11);
    static const UpliftImageType FactoryFault = const UpliftImageType._(12);
    static const UpliftImageType Status = const UpliftImageType._(13);

    final int _value;
    const UpliftImageType._(this._value);
    int get value => _value;
    static List<UpliftImageType> get values => const [ClaimDoc,DamagedOk,DamagedBad,Expired,Recall,Product,OperatorSignature,OperatorRegistration,OutletSignature,GoodStock,Deranged,Overstocked,FactoryFault,Status];
}

class StartSaveUpliftProductImages extends ApiServiceRequest implements IConvertible
{
    UpliftImageType? type;
    int? upliftId;

    StartSaveUpliftProductImages({this.type,this.upliftId});
    StartSaveUpliftProductImages.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'type': JsonConverters.toJson(type,'UpliftImageType',context!),
        'upliftId': upliftId
    });

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

TypeContext _ctx = TypeContext(library: 'antel.api.dev.86degrees.com', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'UpliftImageType': TypeInfo(TypeOf.Enum, enumValues:UpliftImageType.values),
    'StartSaveUpliftProductImages': TypeInfo(TypeOf.Class, create:() => StartSaveUpliftProductImages()),
});

Dart StartSaveUpliftProductImages 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 /uplift/product/startimage HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"type":0,"upliftId":0,"apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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"}}}