Portal

<back to all web services

BrowsePurchaseOrderVersion

The following routes are available for this service:
GET/user/{supplieruserid}/purchaseorder/{purchaseorderid}/purchaseorderversion/{purchaseorderversionid}
import Foundation
import ServiceStack

public class BrowsePurchaseOrderVersion : PurchaseOrderVersionBase, IGet
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class PurchaseOrderVersionBase : PurchaseOrderBase
{
    public var purchaseOrderVersionId:Int

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

    private enum CodingKeys : String, CodingKey {
        case purchaseOrderVersionId
    }

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

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

public class PurchaseOrderBase : Codable
{
    public var purchaseOrderId:Int
    public var supplierUserId:Int

    required public init(){}
}

public class BrowsePurchaseOrderVersionResponse : ResponseBase
{
    public var purchaseOrderVersion:PurchaseOrderVersionDetails

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

    private enum CodingKeys : String, CodingKey {
        case purchaseOrderVersion
    }

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

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

public class ResponseBase : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class PurchaseOrderVersionDetails : PurchaseOrderVersionSimple
{
    public var meta:[String:String] = [:]
    public var viewingDateTime:Date?
    public var reviewingDateTime:Date?
    public var purchaseOrderFiles:[PurchaseOrderFileSimple] = []

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

    private enum CodingKeys : String, CodingKey {
        case meta
        case viewingDateTime
        case reviewingDateTime
        case purchaseOrderFiles
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
        viewingDateTime = try container.decodeIfPresent(Date.self, forKey: .viewingDateTime)
        reviewingDateTime = try container.decodeIfPresent(Date.self, forKey: .reviewingDateTime)
        purchaseOrderFiles = try container.decodeIfPresent([PurchaseOrderFileSimple].self, forKey: .purchaseOrderFiles) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if meta.count > 0 { try container.encode(meta, forKey: .meta) }
        if viewingDateTime != nil { try container.encode(viewingDateTime, forKey: .viewingDateTime) }
        if reviewingDateTime != nil { try container.encode(reviewingDateTime, forKey: .reviewingDateTime) }
        if purchaseOrderFiles.count > 0 { try container.encode(purchaseOrderFiles, forKey: .purchaseOrderFiles) }
    }
}

public class PurchaseOrderVersionSimple : Codable
{
    public var id:Int
    public var purchaseOrderId:Int
    public var supplierUserId:Int
    public var version:Int
    public var isViewed:Bool
    public var status:ReviewStatus

    required public init(){}
}

public enum ReviewStatus : Int, Codable
{
    case Draft = 0
    case Commented = 1
    case Accepted = 2
}

public class PurchaseOrderFileSimple : BrowseFileResponseBase
{
    public var purchaseOrderVersionId:Int
    public var documentType:PurchaseOrderDocumentType

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

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

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

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if purchaseOrderVersionId != nil { try container.encode(purchaseOrderVersionId, forKey: .purchaseOrderVersionId) }
        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 PurchaseOrderDocumentType : Int, Codable
{
    case Draft = 0
    case Comment = 1
}


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

{
	PurchaseOrderVersion: 
	{
		Meta: 
		{
			String: String
		},
		ViewingDateTime: 0001-01-01,
		ReviewingDateTime: 0001-01-01,
		PurchaseOrderFiles: 
		[
			{
				PurchaseOrderVersionId: 0,
				DocumentType: 0,
				Id: 0,
				FileContentId: 0,
				FileName: String,
				Size: 0
			}
		],
		Id: 0,
		PurchaseOrderId: 0,
		SupplierUserId: 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
		}
	}
}