sfgboxapi

<back to all web services

MediaAdd

The following routes are available for this service:
POST/media
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 MediaAdd
            <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 MediaAddResponse
            <DataMember(Order:=2)>
            Public Overridable Property TenantsId As Long

            <DataMember(Order:=3)>
            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 MediaAdd 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.

POST /media HTTP/1.1 
Host: api.sfgtec.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"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

{"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"}}}