Portal

BrowseContractVersion

The following routes are available for this service:
GET	/user/{supplieruserid}/contract/{contractid}/contractversion/{contractversionid}

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 ContractVersionBase(ContractBase):
    contract_version_id: int = 0


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


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


@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 ContractDocumentType(IntEnum):
    DRAFT = 0
    COMMENT = 1


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContractFileSimple(BrowseFileResponseBase):
    contract_version_id: int = 0
    document_type: Optional[ContractDocumentType] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContractVersionDetails(ContractVersionSimple):
    meta: Optional[Dict[str, str]] = None
    viewing_date_time: Optional[datetime.datetime] = None
    reviewing_date_time: Optional[datetime.datetime] = None
    contract_files: Optional[List[ContractFileSimple]] = None


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


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

Python BrowseContractVersion 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}/contractversion/{contractversionid} HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BrowseContractVersionResponse 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>
  <ContractVersion>
    <ContractId>0</ContractId>
    <Id>0</Id>
    <IsViewed>false</IsViewed>
    <Status>Draft</Status>
    <Version>0</Version>
    <ContractFiles>
      <ContractFileSimple>
        <FileContentId>0</FileContentId>
        <FileName>String</FileName>
        <Id>0</Id>
        <Size>0</Size>
        <ContractVersionId>0</ContractVersionId>
        <DocumentType>Draft</DocumentType>
      </ContractFileSimple>
    </ContractFiles>
    <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>
    <ReviewingDateTime>0001-01-01T00:00:00</ReviewingDateTime>
    <ViewingDateTime>0001-01-01T00:00:00</ViewingDateTime>
  </ContractVersion>
</BrowseContractVersionResponse>