Portal

<back to all web services

EditPurchaseOrderVersionMeta

Requires Authentication
Required role:VeoliaAdmin
The following routes are available for this service:
PUT/user/{supplieruserid}/purchaseorder/{purchaseorderid}/purchaseorderversion/{purchaseorderversionid}/meta
import Foundation
import ServiceStack

public class EditPurchaseOrderVersionMeta : PurchaseOrderVersionBase, IPut
{
    public var meta:[String:String] = [:]

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

    private enum CodingKeys : String, CodingKey {
        case meta
    }

    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) ?? [:]
    }

    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) }
    }
}

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 EditPurchaseOrderVersionMeta DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /user/{supplieruserid}/purchaseorder/{purchaseorderid}/purchaseorderversion/{purchaseorderversionid}/meta HTTP/1.1 
Host: szallitoiportal-be.veolia.hu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EditPurchaseOrderVersionMeta xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.ServiceDto">
  <PurchaseOrderId>0</PurchaseOrderId>
  <SupplierUserId>0</SupplierUserId>
  <PurchaseOrderVersionId>0</PurchaseOrderVersionId>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</EditPurchaseOrderVersionMeta>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BrowsePurchaseOrderVersionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Portal.ServiceDto">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <PurchaseOrderVersion>
    <Id>0</Id>
    <IsViewed>false</IsViewed>
    <PurchaseOrderId>0</PurchaseOrderId>
    <Status>Draft</Status>
    <SupplierUserId>0</SupplierUserId>
    <Version>0</Version>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
    <PurchaseOrderFiles>
      <PurchaseOrderFileSimple>
        <FileContentId>0</FileContentId>
        <FileName>String</FileName>
        <Id>0</Id>
        <Size>0</Size>
        <DocumentType>Draft</DocumentType>
        <PurchaseOrderVersionId>0</PurchaseOrderVersionId>
      </PurchaseOrderFileSimple>
    </PurchaseOrderFiles>
    <ReviewingDateTime>0001-01-01T00:00:00</ReviewingDateTime>
    <ViewingDateTime>0001-01-01T00:00:00</ViewingDateTime>
  </PurchaseOrderVersion>
</BrowsePurchaseOrderVersionResponse>