sfgboxapi

<back to all web services

MediaAdd

The following routes are available for this service:
POST/media
import 'package:servicestack/servicestack.dart';

class MediaAddResponse implements IConvertible
{
    // @DataMember(Order=2)
    int? tenantsId;

    // @DataMember(Order=3)
    String? entity;

    // @DataMember(Order=5)
    int? entityId;

    // @DataMember(Order=6)
    String? mediaType;

    // @DataMember(Order=7)
    String? mediaPath;

    // @DataMember(Order=8)
    int? questionnairsId;

    // @DataMember(Order=9)
    String? name;

    // @DataMember(Order=10)
    bool? free;

    // @DataMember(Order=11)
    String? publicAccessGuid;

    // @DataMember(Order=12)
    ResponseStatus? responseStatus;

    MediaAddResponse({this.tenantsId,this.entity,this.entityId,this.mediaType,this.mediaPath,this.questionnairsId,this.name,this.free,this.publicAccessGuid,this.responseStatus});
    MediaAddResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        tenantsId = json['tenantsId'];
        entity = json['entity'];
        entityId = json['entityId'];
        mediaType = json['mediaType'];
        mediaPath = json['mediaPath'];
        questionnairsId = json['questionnairsId'];
        name = json['name'];
        free = json['free'];
        publicAccessGuid = json['publicAccessGuid'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'tenantsId': tenantsId,
        'entity': entity,
        'entityId': entityId,
        'mediaType': mediaType,
        'mediaPath': mediaPath,
        'questionnairsId': questionnairsId,
        'name': name,
        'free': free,
        'publicAccessGuid': publicAccessGuid,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

// @DataContract
class MediaAdd implements IConvertible
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    int? tenantsId;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    String? entity;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    int? entityId;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    String? mediaType;

    // @DataMember(Order=7)
    String? mediaPath;

    // @DataMember(Order=8)
    int? questionnairsId;

    // @DataMember(Order=9)
    String? name;

    // @DataMember(Order=10)
    bool? free;

    // @DataMember(Order=11)
    String? publicAccessGuid;

    MediaAdd({this.tenantsId,this.entity,this.entityId,this.mediaType,this.mediaPath,this.questionnairsId,this.name,this.free,this.publicAccessGuid});
    MediaAdd.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        tenantsId = json['tenantsId'];
        entity = json['entity'];
        entityId = json['entityId'];
        mediaType = json['mediaType'];
        mediaPath = json['mediaPath'];
        questionnairsId = json['questionnairsId'];
        name = json['name'];
        free = json['free'];
        publicAccessGuid = json['publicAccessGuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'tenantsId': tenantsId,
        'entity': entity,
        'entityId': entityId,
        'mediaType': mediaType,
        'mediaPath': mediaPath,
        'questionnairsId': questionnairsId,
        'name': name,
        'free': free,
        'publicAccessGuid': publicAccessGuid
    };

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

TypeContext _ctx = TypeContext(library: 'sfgboxapi.dev.scadsoftware.com', types: <String, TypeInfo> {
    'MediaAddResponse': TypeInfo(TypeOf.Class, create:() => MediaAddResponse()),
    'MediaAdd': TypeInfo(TypeOf.Class, create:() => MediaAdd()),
});

Dart MediaAdd 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 /media HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	entity: String,
	entityId: 0,
	mediaType: String,
	mediaPath: String,
	questionnairsId: 0,
	name: String,
	free: False,
	publicAccessGuid: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	tenantsId: 0,
	entity: String,
	entityId: 0,
	mediaType: String,
	mediaPath: String,
	questionnairsId: 0,
	name: String,
	free: False,
	publicAccessGuid: 00000000000000000000000000000000,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}