sfgboxapi

<back to all web services

MediaEdit

Requires Authentication
The following routes are available for this service:
PUT/media/{Id}
import 'package:servicestack/servicestack.dart';

class MediaEditResponse implements IConvertible
{
    // @DataMember(Order=1)
    int? id;

    // @DataMember(Order=2)
    int? tenantsId;

    // @DataMember(Order=4)
    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;

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

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        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() => {
        'id': id,
        '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() => "MediaEditResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class MediaEdit implements IConvertible
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    int? id;

    // @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;

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

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        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() => {
        'id': id,
        'tenantsId': tenantsId,
        'entity': entity,
        'entityId': entityId,
        'mediaType': mediaType,
        'mediaPath': mediaPath,
        'questionnairsId': questionnairsId,
        'name': name,
        'free': free,
        'publicAccessGuid': publicAccessGuid
    };

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

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

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

PUT /media/{Id} HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"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/csv
Content-Length: length

{"id":0,"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"}}}