Portal

<back to all web services

BrowseSupplierFile

The following routes are available for this service:
GET/supplier/{supplierid}/file/{supplierfileid}
import Foundation
import ServiceStack

public class BrowseSupplierFile : IGet, Codable
{
    public var supplierId:Int
    public var supplierFileId:Int

    required public init(){}
}

public class BrowseSupplierFileResponse : ResponseBase
{
    public var supplierFile:SupplierFileDetails

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case supplierFile
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        supplierFile = try container.decodeIfPresent(SupplierFileDetails.self, forKey: .supplierFile)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if supplierFile != nil { try container.encode(supplierFile, forKey: .supplierFile) }
    }
}

public class ResponseBase : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class SupplierFileDetails : BrowseFileResponseBase
{
    public var supplierId:Int
    public var documentType:SupplierDocumentType

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case supplierId
        case documentType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        supplierId = try container.decodeIfPresent(Int.self, forKey: .supplierId)
        documentType = try container.decodeIfPresent(SupplierDocumentType.self, forKey: .documentType)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if supplierId != nil { try container.encode(supplierId, forKey: .supplierId) }
        if documentType != nil { try container.encode(documentType, forKey: .documentType) }
    }
}

public class BrowseFileResponseBase : Codable
{
    public var id:Int
    public var fileContentId:Int
    public var fileName:String
    public var size:Int

    required public init(){}
}

public enum SupplierDocumentType : Int, Codable
{
    case RegistrationForm = 0
    case SpecimenSignature = 1
}


Swift BrowseSupplierFile 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/{supplierfileid} HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SupplierFile: 
	{
		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
		}
	}
}