Portal

<back to all web services

BrowseContract

The following routes are available for this service:
GET/user/{supplieruserid}/contract/{contractid}
import Foundation
import ServiceStack

public class BrowseContract : ContractBase, 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 ContractBase : Codable
{
    public var supplierUserId:Int
    public var contractId:Int

    required public init(){}
}

public class BrowseContractResponse : ResponseBase
{
    public var contract:ContractDetails

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

    private enum CodingKeys : String, CodingKey {
        case contract
    }

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

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

public class ResponseBase : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ContractDetails : ModifyContractBase
{
    public var id:Int
    public var cancellationDateTime:Date?
    public var isCancelled:Bool
    public var meta:[String:String] = [:]
    public var contractVersions:[ContractVersionSimple] = []
    public var tender:TenderDetails

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

    private enum CodingKeys : String, CodingKey {
        case id
        case cancellationDateTime
        case isCancelled
        case meta
        case contractVersions
        case tender
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        cancellationDateTime = try container.decodeIfPresent(Date.self, forKey: .cancellationDateTime)
        isCancelled = try container.decodeIfPresent(Bool.self, forKey: .isCancelled)
        meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
        contractVersions = try container.decodeIfPresent([ContractVersionSimple].self, forKey: .contractVersions) ?? []
        tender = try container.decodeIfPresent(TenderDetails.self, forKey: .tender)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if cancellationDateTime != nil { try container.encode(cancellationDateTime, forKey: .cancellationDateTime) }
        if isCancelled != nil { try container.encode(isCancelled, forKey: .isCancelled) }
        if meta.count > 0 { try container.encode(meta, forKey: .meta) }
        if contractVersions.count > 0 { try container.encode(contractVersions, forKey: .contractVersions) }
        if tender != nil { try container.encode(tender, forKey: .tender) }
    }
}

public class ModifyContractBase : ModifyRequestBase
{
    public var tenderUserId:Int?
    public var contractIdentifier:String
    public var supplierUserId:Int
    public var buyer:String
    public var subject:String
    public var confirmationDeadline:Date

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

    private enum CodingKeys : String, CodingKey {
        case tenderUserId
        case contractIdentifier
        case supplierUserId
        case buyer
        case subject
        case confirmationDeadline
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        tenderUserId = try container.decodeIfPresent(Int.self, forKey: .tenderUserId)
        contractIdentifier = try container.decodeIfPresent(String.self, forKey: .contractIdentifier)
        supplierUserId = try container.decodeIfPresent(Int.self, forKey: .supplierUserId)
        buyer = try container.decodeIfPresent(String.self, forKey: .buyer)
        subject = try container.decodeIfPresent(String.self, forKey: .subject)
        confirmationDeadline = try container.decodeIfPresent(Date.self, forKey: .confirmationDeadline)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if tenderUserId != nil { try container.encode(tenderUserId, forKey: .tenderUserId) }
        if contractIdentifier != nil { try container.encode(contractIdentifier, forKey: .contractIdentifier) }
        if supplierUserId != nil { try container.encode(supplierUserId, forKey: .supplierUserId) }
        if buyer != nil { try container.encode(buyer, forKey: .buyer) }
        if subject != nil { try container.encode(subject, forKey: .subject) }
        if confirmationDeadline != nil { try container.encode(confirmationDeadline, forKey: .confirmationDeadline) }
    }
}

public class ModifyRequestBase : IConcurrencyStamp, Codable
{
    public var concurrencyStamp:String

    required public init(){}
}

public class ContractVersionSimple : Codable
{
    public var id:Int
    public var contractId:Int
    public var version:Int
    public var isViewed:Bool
    public var status:ReviewStatus

    required public init(){}
}

public enum ReviewStatus : Int, Codable
{
    case Draft = 0
    case Commented = 1
    case Accepted = 2
}

public class TenderDetails : TenderBase, IConcurrencyStamp
{
    public var id:Int
    public var starterTenderRoundId:Int?
    public var procedureType:ProcedureType
    public var meta:[String:String] = [:]
    public var tenderFiles:[TenderFileDetails] = []
    public var tenderRounds:[TenderRoundSimple] = []
    public var concurrencyStamp:String
    public var isProcurementEnabled:Bool
    public var isComplianceEnabled:Bool

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

    private enum CodingKeys : String, CodingKey {
        case id
        case starterTenderRoundId
        case procedureType
        case meta
        case tenderFiles
        case tenderRounds
        case concurrencyStamp
        case isProcurementEnabled
        case isComplianceEnabled
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        starterTenderRoundId = try container.decodeIfPresent(Int.self, forKey: .starterTenderRoundId)
        procedureType = try container.decodeIfPresent(ProcedureType.self, forKey: .procedureType)
        meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
        tenderFiles = try container.decodeIfPresent([TenderFileDetails].self, forKey: .tenderFiles) ?? []
        tenderRounds = try container.decodeIfPresent([TenderRoundSimple].self, forKey: .tenderRounds) ?? []
        concurrencyStamp = try container.decodeIfPresent(String.self, forKey: .concurrencyStamp)
        isProcurementEnabled = try container.decodeIfPresent(Bool.self, forKey: .isProcurementEnabled)
        isComplianceEnabled = try container.decodeIfPresent(Bool.self, forKey: .isComplianceEnabled)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if starterTenderRoundId != nil { try container.encode(starterTenderRoundId, forKey: .starterTenderRoundId) }
        if procedureType != nil { try container.encode(procedureType, forKey: .procedureType) }
        if meta.count > 0 { try container.encode(meta, forKey: .meta) }
        if tenderFiles.count > 0 { try container.encode(tenderFiles, forKey: .tenderFiles) }
        if tenderRounds.count > 0 { try container.encode(tenderRounds, forKey: .tenderRounds) }
        if concurrencyStamp != nil { try container.encode(concurrencyStamp, forKey: .concurrencyStamp) }
        if isProcurementEnabled != nil { try container.encode(isProcurementEnabled, forKey: .isProcurementEnabled) }
        if isComplianceEnabled != nil { try container.encode(isComplianceEnabled, forKey: .isComplianceEnabled) }
    }
}

public class TenderBase : Codable
{
    public var tenderIdentifier:String
    public var tenderType:TenderType
    public var subject:String
    public var procurementContact:String
    public var procurementContactEmail:String
    public var procurementContactPhone:String
    public var professionalContact:String
    public var professionalContactEmail:String
    public var professionalContactPhone:String
    public var result:String
    public var status:TenderStatus

    required public init(){}
}

public enum TenderType : Int, Codable
{
    case Private = 0
    case Public = 1
}

public enum TenderStatus : Int, Codable
{
    case FirstRound = 0
    case SecondRound = 1
    case ThirdRound = 2
    case Successful = 3
    case UnSuccessful = 4
    case Revoked = 5
}

public enum ProcedureType : Int, Codable
{
    case Competition = 0
    case Simplified = 1
}

public class TenderFileDetails : BrowseFileResponseBase
{
    public var tenderId:Int
    public var documentType:String
    public var isTenderAnnouncement:Bool

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

    private enum CodingKeys : String, CodingKey {
        case tenderId
        case documentType
        case isTenderAnnouncement
    }

    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)
        documentType = try container.decodeIfPresent(String.self, forKey: .documentType)
        isTenderAnnouncement = try container.decodeIfPresent(Bool.self, forKey: .isTenderAnnouncement)
    }

    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 documentType != nil { try container.encode(documentType, forKey: .documentType) }
        if isTenderAnnouncement != nil { try container.encode(isTenderAnnouncement, forKey: .isTenderAnnouncement) }
    }
}

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

    required public init(){}
}

public class TenderRoundSimple : Codable
{
    public var id:Int
    public var name:String
    public var isQuestionEnabled:Bool
    public var questionDeadline:Date?
    public var answerDeadline:Date?
    public var submissionDeadline:Date
    public var isSupplementaryEnabled:Bool
    public var supplementaryRequestDeadline:Date?
    public var supplementaryDeadline:Date?
    public var announcementDateTime:Date
    public var status:Int

    required public init(){}
}


Swift BrowseContract DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /user/{supplieruserid}/contract/{contractid} HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BrowseContractResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.ServiceDto">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Contract>
    <ConcurrencyStamp>String</ConcurrencyStamp>
    <Buyer>String</Buyer>
    <ConfirmationDeadline>0001-01-01T00:00:00</ConfirmationDeadline>
    <ContractIdentifier>String</ContractIdentifier>
    <Subject>String</Subject>
    <SupplierUserId>0</SupplierUserId>
    <TenderUserId>0</TenderUserId>
    <CancellationDateTime>0001-01-01T00:00:00</CancellationDateTime>
    <ContractVersions>
      <ContractVersionSimple>
        <ContractId>0</ContractId>
        <Id>0</Id>
        <IsViewed>false</IsViewed>
        <Status>Draft</Status>
        <Version>0</Version>
      </ContractVersionSimple>
    </ContractVersions>
    <Id>0</Id>
    <IsCancelled>false</IsCancelled>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
    <Tender>
      <ProcurementContact>String</ProcurementContact>
      <ProcurementContactEmail>String</ProcurementContactEmail>
      <ProcurementContactPhone>String</ProcurementContactPhone>
      <ProfessionalContact>String</ProfessionalContact>
      <ProfessionalContactEmail>String</ProfessionalContactEmail>
      <ProfessionalContactPhone>String</ProfessionalContactPhone>
      <Result>String</Result>
      <Status>FirstRound</Status>
      <Subject>String</Subject>
      <TenderIdentifier>String</TenderIdentifier>
      <TenderType>Private</TenderType>
      <ConcurrencyStamp>String</ConcurrencyStamp>
      <Id>0</Id>
      <IsComplianceEnabled>false</IsComplianceEnabled>
      <IsProcurementEnabled>false</IsProcurementEnabled>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
      <ProcedureType>Competition</ProcedureType>
      <StarterTenderRoundId>0</StarterTenderRoundId>
      <TenderFiles>
        <TenderFileDetails>
          <FileContentId>0</FileContentId>
          <FileName>String</FileName>
          <Id>0</Id>
          <Size>0</Size>
          <DocumentType>String</DocumentType>
          <IsTenderAnnouncement>false</IsTenderAnnouncement>
          <TenderId>0</TenderId>
        </TenderFileDetails>
      </TenderFiles>
      <TenderRounds>
        <TenderRoundSimple>
          <AnnouncementDateTime>0001-01-01T00:00:00</AnnouncementDateTime>
          <AnswerDeadline>0001-01-01T00:00:00</AnswerDeadline>
          <Id>0</Id>
          <IsQuestionEnabled>false</IsQuestionEnabled>
          <IsSupplementaryEnabled>false</IsSupplementaryEnabled>
          <Name>String</Name>
          <QuestionDeadline>0001-01-01T00:00:00</QuestionDeadline>
          <Status>0</Status>
          <SubmissionDeadline>0001-01-01T00:00:00</SubmissionDeadline>
          <SupplementaryDeadline>0001-01-01T00:00:00</SupplementaryDeadline>
          <SupplementaryRequestDeadline>0001-01-01T00:00:00</SupplementaryRequestDeadline>
        </TenderRoundSimple>
      </TenderRounds>
    </Tender>
  </Contract>
</BrowseContractResponse>