sfgboxapi

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<MediaAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <TenantsId>0</TenantsId>
  <Entity>String</Entity>
  <EntityId>0</EntityId>
  <MediaType>String</MediaType>
  <MediaPath>String</MediaPath>
  <QuestionnairsId>0</QuestionnairsId>
  <Name>String</Name>
  <Free>false</Free>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
</MediaAdd>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MediaAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sfgboxapi.ServiceModel">
  <Entity>String</Entity>
  <EntityId>0</EntityId>
  <Free>false</Free>
  <MediaPath>String</MediaPath>
  <MediaType>String</MediaType>
  <Name>String</Name>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <QuestionnairsId>0</QuestionnairsId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TenantsId>0</TenantsId>
</MediaAddResponse>