sfgboxapi

<back to all web services

MediaEdit

Requires Authentication
The following routes are available for this service:
PUT/media/{Id}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports sfgboxapi.ServiceModel

Namespace Global

    Namespace sfgboxapi.ServiceModel

        <DataContract>
        Public Partial Class MediaEdit
            <DataMember(Order:=1)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property TenantsId As Long

            <DataMember(Order:=4)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Entity As String

            <DataMember(Order:=5)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property EntityId As Long

            <DataMember(Order:=6)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property MediaType As String

            <DataMember(Order:=7)>
            Public Overridable Property MediaPath As String

            <DataMember(Order:=8)>
            Public Overridable Property QuestionnairsId As Nullable(Of Long)

            <DataMember(Order:=9)>
            Public Overridable Property Name As String

            <DataMember(Order:=10)>
            Public Overridable Property Free As Boolean

            <DataMember(Order:=11)>
            Public Overridable Property PublicAccessGuid As Guid
        End Class

        Public Partial Class MediaEditResponse
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            Public Overridable Property TenantsId As Long

            <DataMember(Order:=4)>
            Public Overridable Property Entity As String

            <DataMember(Order:=5)>
            Public Overridable Property EntityId As Long

            <DataMember(Order:=6)>
            Public Overridable Property MediaType As String

            <DataMember(Order:=7)>
            Public Overridable Property MediaPath As String

            <DataMember(Order:=8)>
            Public Overridable Property QuestionnairsId As Nullable(Of Long)

            <DataMember(Order:=9)>
            Public Overridable Property Name As String

            <DataMember(Order:=10)>
            Public Overridable Property Free As Boolean

            <DataMember(Order:=11)>
            Public Overridable Property PublicAccessGuid As Guid

            <DataMember(Order:=12)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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
		}
	}
}