sfgboxapi

<back to all web services

MediaEdit

Requires Authentication
The following routes are available for this service:
PUT/media/{Id}
import java.math.*
import java.util.*
import net.servicestack.client.*


@DataContract
open class MediaEdit
{
    @DataMember(Order=1)
    @Validate(Validator="NotNull")
    var id:Long? = null

    @DataMember(Order=2)
    @Validate(Validator="NotNull")
    var tenantsId:Long? = null

    @DataMember(Order=4)
    @Validate(Validator="NotNull")
    var entity:String? = null

    @DataMember(Order=5)
    @Validate(Validator="NotNull")
    var entityId:Long? = null

    @DataMember(Order=6)
    @Validate(Validator="NotNull")
    var mediaType:String? = null

    @DataMember(Order=7)
    var mediaPath:String? = null

    @DataMember(Order=8)
    var questionnairsId:Long? = null

    @DataMember(Order=9)
    var name:String? = null

    @DataMember(Order=10)
    var free:Boolean? = null

    @DataMember(Order=11)
    var publicAccessGuid:UUID? = null
}

open class MediaEditResponse
{
    @DataMember(Order=1)
    var id:Long? = null

    @DataMember(Order=2)
    var tenantsId:Long? = null

    @DataMember(Order=4)
    var entity:String? = null

    @DataMember(Order=5)
    var entityId:Long? = null

    @DataMember(Order=6)
    var mediaType:String? = null

    @DataMember(Order=7)
    var mediaPath:String? = null

    @DataMember(Order=8)
    var questionnairsId:Long? = null

    @DataMember(Order=9)
    var name:String? = null

    @DataMember(Order=10)
    var free:Boolean? = null

    @DataMember(Order=11)
    var publicAccessGuid:UUID? = null

    @DataMember(Order=12)
    var responseStatus:ResponseStatus? = null
}

Kotlin MediaEdit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}