Portal

<back to all web services

BrowseSupplementaryByVeoliaAdmin

The following routes are available for this service:
GET/supplementary/{supplementaryid}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Portal.ServiceDto
Imports Portal.Common

Namespace Global

    Namespace Portal.Common

        Public Enum SupplementaryFileDirection
            Request = 0
            Response = 1
        End Enum
    End Namespace

    Namespace Portal.ServiceDto

        Public Partial Class BrowseFileResponseBase
            Public Overridable Property Id As Integer
            Public Overridable Property FileContentId As Integer
            Public Overridable Property FileName As String
            Public Overridable Property Size As Long
        End Class

        Public Partial Class BrowseSupplementaryByVeoliaAdmin
            Implements IGet
            Public Overridable Property SupplementaryId As Integer
        End Class

        Public Partial Class BrowseSupplementaryResponse
            Inherits ResponseBase
            Public Overridable Property Supplementary As SupplementaryDetails
        End Class

        Public Partial Class ResponseBase
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class SupplementaryDetails
            Inherits SupplementarySimple
            Public Sub New()
                Meta = New Dictionary(Of String, String)
                SupplementaryFiles = New List(Of SupplementaryFileDetails)
            End Sub

            Public Overridable Property TenderId As Integer
            Public Overridable Property TenderUserId As Integer
            Public Overridable Property UserId As Integer
            Public Overridable Property TenderRoundId As Integer
            Public Overridable Property ViewedById As Nullable(Of Integer)
            Public Overridable Property SubmittedById As Nullable(Of Integer)
            Public Overridable Property Meta As Dictionary(Of String, String)
            Public Overridable Property SupplementaryFiles As List(Of SupplementaryFileDetails)
        End Class

        Public Partial Class SupplementaryFileDetails
            Inherits BrowseFileResponseBase
            Public Overridable Property SupplementaryId As Integer
            Public Overridable Property SupplementaryDocumentTypeId As Integer
            Public Overridable Property SupplementaryDocumentType As String
            Public Overridable Property Direction As SupplementaryFileDirection
        End Class

        Public Partial Class SupplementarySimple
            Public Overridable Property Id As Integer
            Public Overridable Property TenderUserTenderRoundId As Integer
            Public Overridable Property IsViewed As Boolean
            Public Overridable Property ViewingDateTime As Nullable(Of Date)
            Public Overridable Property IsSubmitted As Boolean
            Public Overridable Property SubmissionDateTime As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

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

GET /supplementary/{supplementaryid} HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Supplementary":{"TenderId":0,"TenderUserId":0,"UserId":0,"TenderRoundId":0,"ViewedById":0,"SubmittedById":0,"Meta":{"String":"String"},"SupplementaryFiles":[{"SupplementaryId":0,"SupplementaryDocumentTypeId":0,"SupplementaryDocumentType":"String","Direction":0,"Id":0,"FileContentId":0,"FileName":"String","Size":0}],"Id":0,"TenderUserTenderRoundId":0,"IsViewed":false,"ViewingDateTime":"0001-01-01T00:00:00.0000000","IsSubmitted":false,"SubmissionDateTime":"0001-01-01T00:00:00.0000000"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}