ImageServiceAPI

<back to all web services

PostImageRequest

Requires Authentication
The following routes are available for this service:
POST/v4/images
import 'package:servicestack/servicestack.dart';

// @DataContract
class V4BaseRequest implements IConvertible
{
    V4BaseRequest();
    V4BaseRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "V4BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class V4BaseResponse implements IConvertible
{
    // @DataMember(Name="status")
    ResponseStatus? status;

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

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

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

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

// @DataContract
class PostImageResponse extends V4BaseResponse implements IPostImageResponse, IConvertible
{
    PostImageResponse();
    PostImageResponse.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() => "PostImageResponse";
    TypeContext? context = _ctx;
}

enum ImageProvider
{
    None,
    Cloudinary,
}

// @DataContract
class PostImageRequest extends V4BaseRequest implements IPostImageRequest, IConvertible
{
    // @DataMember(Name="provider")
    ImageProvider? provider;

    // @DataMember(Name="providerImageId")
    String? providerImageId;

    // @DataMember(Name="attributes")
    Map<String,String?>? attributes;

    PostImageRequest({this.provider,this.providerImageId,this.attributes});
    PostImageRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        provider = JsonConverters.fromJson(json['provider'],'ImageProvider',context!);
        providerImageId = json['providerImageId'];
        attributes = JsonConverters.toStringMap(json['attributes']);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'provider': JsonConverters.toJson(provider,'ImageProvider',context!),
        'providerImageId': providerImageId,
        'attributes': attributes
    });

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

TypeContext _ctx = TypeContext(library: 'image_service_api.qa.platform.georiot.com', types: <String, TypeInfo> {
    'V4BaseRequest': TypeInfo(TypeOf.Class, create:() => V4BaseRequest()),
    'V4BaseResponse': TypeInfo(TypeOf.Class, create:() => V4BaseResponse()),
    'PostImageResponse': TypeInfo(TypeOf.Class, create:() => PostImageResponse()),
    'ImageProvider': TypeInfo(TypeOf.Enum, enumValues:ImageProvider.values),
    'PostImageRequest': TypeInfo(TypeOf.Class, create:() => PostImageRequest()),
});

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

POST /v4/images HTTP/1.1 
Host: image-service-api.qa.platform.georiot.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	provider: None,
	providerImageId: String,
	attributes: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}