Portal

<back to all web services

BrowseAllSupplierFile

The following routes are available for this service:
GET/supplier/{supplierid}/file
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 BrowseFileResponseBase:
    id: int = 0
    file_content_id: int = 0
    file_name: Optional[str] = None
    size: int = 0


class SupplierDocumentType(IntEnum):
    REGISTRATION_FORM = 0
    SPECIMEN_SIGNATURE = 1


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BrowseAllSupplierFileResponse(ResponseBase):
    supplier_files: Optional[List[SupplierFileDetails]] = None


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

Python BrowseAllSupplierFile 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 /supplier/{supplierid}/file HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SupplierFiles: 
	[
		{
			SupplierId: 0,
			DocumentType: 0,
			Id: 0,
			FileContentId: 0,
			FileName: String,
			Size: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}