Portal

<back to all web services

BrowseSupplementaryByVeoliaAdmin

The following routes are available for this service:
GET/supplementary/{supplementaryid}
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 ResponseBase:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplementarySimple:
    id: int = 0
    tender_user_tender_round_id: int = 0
    is_viewed: bool = False
    viewing_date_time: Optional[datetime.datetime] = None
    is_submitted: bool = False
    submission_date_time: Optional[datetime.datetime] = None


@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


class SupplementaryFileDirection(IntEnum):
    REQUEST = 0
    RESPONSE = 1


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplementaryFileDetails(BrowseFileResponseBase):
    supplementary_id: int = 0
    supplementary_document_type_id: int = 0
    supplementary_document_type: Optional[str] = None
    direction: Optional[SupplementaryFileDirection] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SupplementaryDetails(SupplementarySimple):
    tender_id: int = 0
    tender_user_id: int = 0
    user_id: int = 0
    tender_round_id: int = 0
    viewed_by_id: Optional[int] = None
    submitted_by_id: Optional[int] = None
    meta: Optional[Dict[str, str]] = None
    supplementary_files: Optional[List[SupplementaryFileDetails]] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BrowseSupplementaryByVeoliaAdmin(IGet):
    supplementary_id: int = 0

Python BrowseSupplementaryByVeoliaAdmin 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 /supplementary/{supplementaryid} HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BrowseSupplementaryResponse 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>
  <Supplementary>
    <Id>0</Id>
    <IsSubmitted>false</IsSubmitted>
    <IsViewed>false</IsViewed>
    <SubmissionDateTime>0001-01-01T00:00:00</SubmissionDateTime>
    <TenderUserTenderRoundId>0</TenderUserTenderRoundId>
    <ViewingDateTime>0001-01-01T00:00:00</ViewingDateTime>
    <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>
    <SubmittedById>0</SubmittedById>
    <SupplementaryFiles>
      <SupplementaryFileDetails>
        <FileContentId>0</FileContentId>
        <FileName>String</FileName>
        <Id>0</Id>
        <Size>0</Size>
        <Direction>Request</Direction>
        <SupplementaryDocumentType>String</SupplementaryDocumentType>
        <SupplementaryDocumentTypeId>0</SupplementaryDocumentTypeId>
        <SupplementaryId>0</SupplementaryId>
      </SupplementaryFileDetails>
    </SupplementaryFiles>
    <TenderId>0</TenderId>
    <TenderRoundId>0</TenderRoundId>
    <TenderUserId>0</TenderUserId>
    <UserId>0</UserId>
    <ViewedById>0</ViewedById>
  </Supplementary>
</BrowseSupplementaryResponse>