Portal

<back to all web services

AddPurchaseOrderFileComment

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

public class AddPurchaseOrderFileComment : AddPurchaseOrderVersionFileBase, IPost
{
    public var documentType:PurchaseOrderDocumentType

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

    private enum CodingKeys : String, CodingKey {
        case documentType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        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 documentType != nil { try container.encode(documentType, forKey: .documentType) }
    }
}

public class AddPurchaseOrderVersionFileBase : PurchaseOrderVersionBase
{
    public var documentType:PurchaseOrderDocumentType

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

    private enum CodingKeys : String, CodingKey {
        case documentType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        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 documentType != nil { try container.encode(documentType, forKey: .documentType) }
    }
}

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 enum PurchaseOrderDocumentType : Int, Codable
{
    case Draft = 0
    case Comment = 1
}

public class SaveFileEntityResponse : ModifyEntityResponse
{
    public var fileContentId:Int

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

    private enum CodingKeys : String, CodingKey {
        case fileContentId
    }

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

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

public class ModifyEntityResponse : ResponseBase
{
    public var id:Int

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

    private enum CodingKeys : String, CodingKey {
        case id
    }

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

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

public class ResponseBase : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift AddPurchaseOrderFileComment 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.

POST /user/{supplieruserid}/purchaseorder/{purchaseorderid}/purchaseorderversion/{purchaseorderversionid}/file/comment HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DocumentType: 1,
	PurchaseOrderVersionId: 0,
	PurchaseOrderId: 0,
	SupplierUserId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FileContentId: 0,
	Id: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}