Portal

<back to all web services

BrowseSupplementary

The following routes are available for this service:
GET/tender/{tenderid}/user/{userid}/round/{tenderroundid}/supplementary/{supplementaryid}
import Foundation
import ServiceStack

public class BrowseSupplementary : SupplementaryBase, IGet
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class SupplementaryBase : TenderUserTenderRoundBase
{
    public var supplementaryId:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case supplementaryId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        supplementaryId = try container.decodeIfPresent(Int.self, forKey: .supplementaryId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if supplementaryId != nil { try container.encode(supplementaryId, forKey: .supplementaryId) }
    }
}

public class TenderUserTenderRoundBase : Codable
{
    public var tenderId:Int
    public var userId:Int
    public var tenderRoundId:Int

    required public init(){}
}

public class BrowseSupplementaryResponse : ResponseBase
{
    public var supplementary:SupplementaryDetails

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case supplementary
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        supplementary = try container.decodeIfPresent(SupplementaryDetails.self, forKey: .supplementary)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if supplementary != nil { try container.encode(supplementary, forKey: .supplementary) }
    }
}

public class ResponseBase : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class SupplementaryDetails : SupplementarySimple
{
    public var tenderId:Int
    public var tenderUserId:Int
    public var userId:Int
    public var tenderRoundId:Int
    public var viewedById:Int?
    public var submittedById:Int?
    public var meta:[String:String] = [:]
    public var supplementaryFiles:[SupplementaryFileDetails] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case tenderId
        case tenderUserId
        case userId
        case tenderRoundId
        case viewedById
        case submittedById
        case meta
        case supplementaryFiles
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        tenderId = try container.decodeIfPresent(Int.self, forKey: .tenderId)
        tenderUserId = try container.decodeIfPresent(Int.self, forKey: .tenderUserId)
        userId = try container.decodeIfPresent(Int.self, forKey: .userId)
        tenderRoundId = try container.decodeIfPresent(Int.self, forKey: .tenderRoundId)
        viewedById = try container.decodeIfPresent(Int.self, forKey: .viewedById)
        submittedById = try container.decodeIfPresent(Int.self, forKey: .submittedById)
        meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
        supplementaryFiles = try container.decodeIfPresent([SupplementaryFileDetails].self, forKey: .supplementaryFiles) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if tenderId != nil { try container.encode(tenderId, forKey: .tenderId) }
        if tenderUserId != nil { try container.encode(tenderUserId, forKey: .tenderUserId) }
        if userId != nil { try container.encode(userId, forKey: .userId) }
        if tenderRoundId != nil { try container.encode(tenderRoundId, forKey: .tenderRoundId) }
        if viewedById != nil { try container.encode(viewedById, forKey: .viewedById) }
        if submittedById != nil { try container.encode(submittedById, forKey: .submittedById) }
        if meta.count > 0 { try container.encode(meta, forKey: .meta) }
        if supplementaryFiles.count > 0 { try container.encode(supplementaryFiles, forKey: .supplementaryFiles) }
    }
}

public class SupplementarySimple : Codable
{
    public var id:Int
    public var tenderUserTenderRoundId:Int
    public var isViewed:Bool
    public var viewingDateTime:Date?
    public var isSubmitted:Bool
    public var submissionDateTime:Date?

    required public init(){}
}

public class SupplementaryFileDetails : BrowseFileResponseBase
{
    public var supplementaryId:Int
    public var supplementaryDocumentTypeId:Int
    public var supplementaryDocumentType:String
    public var direction:SupplementaryFileDirection

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case supplementaryId
        case supplementaryDocumentTypeId
        case supplementaryDocumentType
        case direction
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        supplementaryId = try container.decodeIfPresent(Int.self, forKey: .supplementaryId)
        supplementaryDocumentTypeId = try container.decodeIfPresent(Int.self, forKey: .supplementaryDocumentTypeId)
        supplementaryDocumentType = try container.decodeIfPresent(String.self, forKey: .supplementaryDocumentType)
        direction = try container.decodeIfPresent(SupplementaryFileDirection.self, forKey: .direction)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if supplementaryId != nil { try container.encode(supplementaryId, forKey: .supplementaryId) }
        if supplementaryDocumentTypeId != nil { try container.encode(supplementaryDocumentTypeId, forKey: .supplementaryDocumentTypeId) }
        if supplementaryDocumentType != nil { try container.encode(supplementaryDocumentType, forKey: .supplementaryDocumentType) }
        if direction != nil { try container.encode(direction, forKey: .direction) }
    }
}

public class BrowseFileResponseBase : Codable
{
    public var id:Int
    public var fileContentId:Int
    public var fileName:String
    public var size:Int

    required public init(){}
}

public enum SupplementaryFileDirection : Int, Codable
{
    case Request = 0
    case Response = 1
}


Swift BrowseSupplementary 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 /tender/{tenderid}/user/{userid}/round/{tenderroundid}/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"}}}