sfgboxapi

<back to all web services

MediaEdit

Requires Authentication
The following routes are available for this service:
PUT/media/{Id}
import Foundation
import ServiceStack

// @DataContract
public class MediaEdit : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var id:Int

    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var tenantsId:Int

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public var entity:String

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public var entityId:Int

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public var mediaType:String

    // @DataMember(Order=7)
    public var mediaPath:String

    // @DataMember(Order=8)
    public var questionnairsId:Int?

    // @DataMember(Order=9)
    public var name:String

    // @DataMember(Order=10)
    public var free:Bool

    // @DataMember(Order=11)
    public var publicAccessGuid:String

    required public init(){}
}

public class MediaEditResponse : Codable
{
    // @DataMember(Order=1)
    public var id:Int

    // @DataMember(Order=2)
    public var tenantsId:Int

    // @DataMember(Order=4)
    public var entity:String

    // @DataMember(Order=5)
    public var entityId:Int

    // @DataMember(Order=6)
    public var mediaType:String

    // @DataMember(Order=7)
    public var mediaPath:String

    // @DataMember(Order=8)
    public var questionnairsId:Int?

    // @DataMember(Order=9)
    public var name:String

    // @DataMember(Order=10)
    public var free:Bool

    // @DataMember(Order=11)
    public var publicAccessGuid:String

    // @DataMember(Order=12)
    public var responseStatus:ResponseStatus

    required public init(){}
}


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

PUT /media/{Id} HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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
		}
	}
}