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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ContractVersion: 
	{
		Meta: 
		{
			String: String
		},
		ViewingDateTime: 0001-01-01,
		ReviewingDateTime: 0001-01-01,
		ContractFiles: 
		[
			{
				ContractVersionId: 0,
				DocumentType: 0,
				Id: 0,
				FileContentId: 0,
				FileName: String,
				Size: 0
			}
		],
		Id: 0,
		ContractId: 0,
		Version: 0,
		IsViewed: False,
		Status: 0
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}