Portal

<back to all web services

BrowseContract

The following routes are available for this service:
GET/user/{supplieruserid}/contract/{contractid}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContractBase:
    supplier_user_id: int = 0
    contract_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseBase:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ModifyRequestBase(IConcurrencyStamp):
    concurrency_stamp: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ModifyContractBase(ModifyRequestBase):
    tender_user_id: Optional[int] = None
    contract_identifier: Optional[str] = None
    supplier_user_id: int = 0
    buyer: Optional[str] = None
    subject: Optional[str] = None
    confirmation_deadline: datetime.datetime = datetime.datetime(1, 1, 1)


class ReviewStatus(IntEnum):
    DRAFT = 0
    COMMENTED = 1
    ACCEPTED = 2


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContractVersionSimple:
    id: int = 0
    contract_id: int = 0
    version: int = 0
    is_viewed: bool = False
    status: Optional[ReviewStatus] = None


class TenderType(IntEnum):
    PRIVATE = 0
    PUBLIC = 1


class TenderStatus(IntEnum):
    FIRST_ROUND = 0
    SECOND_ROUND = 1
    THIRD_ROUND = 2
    SUCCESSFUL = 3
    UN_SUCCESSFUL = 4
    REVOKED = 5


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TenderBase:
    tender_identifier: Optional[str] = None
    tender_type: Optional[TenderType] = None
    subject: Optional[str] = None
    procurement_contact: Optional[str] = None
    procurement_contact_email: Optional[str] = None
    procurement_contact_phone: Optional[str] = None
    professional_contact: Optional[str] = None
    professional_contact_email: Optional[str] = None
    professional_contact_phone: Optional[str] = None
    result: Optional[str] = None
    status: Optional[TenderStatus] = None


class ProcedureType(IntEnum):
    COMPETITION = 0
    SIMPLIFIED = 1


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BrowseFileResponseBase:
    id: int = 0
    file_content_id: int = 0
    file_name: Optional[str] = None
    size: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TenderFileDetails(BrowseFileResponseBase):
    tender_id: int = 0
    document_type: Optional[str] = None
    is_tender_announcement: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TenderRoundSimple:
    id: int = 0
    name: Optional[str] = None
    is_question_enabled: bool = False
    question_deadline: Optional[datetime.datetime] = None
    answer_deadline: Optional[datetime.datetime] = None
    submission_deadline: datetime.datetime = datetime.datetime(1, 1, 1)
    is_supplementary_enabled: bool = False
    supplementary_request_deadline: Optional[datetime.datetime] = None
    supplementary_deadline: Optional[datetime.datetime] = None
    announcement_date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    status: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TenderDetails(TenderBase, IConcurrencyStamp):
    id: int = 0
    starter_tender_round_id: Optional[int] = None
    procedure_type: Optional[ProcedureType] = None
    meta: Optional[Dict[str, str]] = None
    tender_files: Optional[List[TenderFileDetails]] = None
    tender_rounds: Optional[List[TenderRoundSimple]] = None
    concurrency_stamp: Optional[str] = None
    is_procurement_enabled: bool = False
    is_compliance_enabled: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContractDetails(ModifyContractBase):
    id: int = 0
    cancellation_date_time: Optional[datetime.datetime] = None
    is_cancelled: bool = False
    meta: Optional[Dict[str, str]] = None
    contract_versions: Optional[List[ContractVersionSimple]] = None
    tender: Optional[TenderDetails] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BrowseContractResponse(ResponseBase):
    contract: Optional[ContractDetails] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BrowseContract(ContractBase, IGet):
    pass

Python 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>