POST | /api/DMS/UploadFile |
---|
import Foundation
import ServiceStack
public class UploadFile : Codable
{
public var registrationProfileID:String?
public var navigationPath:String?
public var fileName:String?
public var Description:String?
public var documentUpload:Bool?
public var metaData:[MetaDataField] = []
public var documentID:String?
public var hoofdDocumentID:String?
public var subDocumentIDs:[String] = []
required public init(){}
}
// @DataContract
public class MetaDataField : Codable
{
// @DataMember
public var id:String?
// @DataMember
public var documentVeldID:String?
// @DataMember
public var name:String?
// @DataMember
public var label:String?
// @DataMember
public var datatype:String?
// @DataMember
public var printLabel:String?
// @DataMember
public var entity:String?
// @DataMember
public var printValue:String?
// @DataMember
public var registrationValue:String?
// @DataMember
public var spSiteColumnName:String?
// @DataMember
public var shadowName:String?
// @DataMember
public var shadowDatatype:String?
// @DataMember
public var shadowSPSiteColumnName:String?
// @DataMember
public var shadowSPSiteColumnRegistrationValue:String?
// @DataMember
public var shadowRegistrationValue:String?
// @DataMember
public var isKeyField:Bool?
// @DataMember
public var kopierenBijNieuweVersie:Bool?
required public init(){}
}
// @DataContract
public class UploadFileResponse : Codable
{
// @DataMember
public var documentId:String?
// @DataMember
public var documentUploadId:Int?
// @DataMember
public var documentNr:String?
// @DataMember
public var messages:InformationMessages?
required public init(){}
}
public class InformationMessages : List<InformationMessageBase>, IInformationMessages
{
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 InformationMessageBase : IInformationMessage, Codable
{
public var type:MessageType?
public var summary:String?
public var fullMessage:String?
public var fieldName:String?
public var keepOpen:Bool?
required public init(){}
}
public enum MessageType : Int, Codable
{
case Information = 1
case Warning = 2
case Error = 3
case Success = 4
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/DMS/UploadFile HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UploadFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DMS.Operations">
<Description>String</Description>
<DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
<DocumentUpload>false</DocumentUpload>
<FileName>String</FileName>
<HoofdDocumentID>00000000-0000-0000-0000-000000000000</HoofdDocumentID>
<MetaData xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DMS">
<d2p1:MetaDataField>
<d2p1:Datatype>String</d2p1:Datatype>
<d2p1:DocumentVeldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentVeldID>
<d2p1:Entity>String</d2p1:Entity>
<d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
<d2p1:IsKeyField>false</d2p1:IsKeyField>
<d2p1:KopierenBijNieuweVersie>false</d2p1:KopierenBijNieuweVersie>
<d2p1:Label>String</d2p1:Label>
<d2p1:Name>String</d2p1:Name>
<d2p1:PrintLabel>String</d2p1:PrintLabel>
<d2p1:PrintValue>String</d2p1:PrintValue>
<d2p1:RegistrationValue>String</d2p1:RegistrationValue>
<d2p1:SPSiteColumnName>String</d2p1:SPSiteColumnName>
<d2p1:ShadowDatatype>String</d2p1:ShadowDatatype>
<d2p1:ShadowName>String</d2p1:ShadowName>
<d2p1:ShadowRegistrationValue>String</d2p1:ShadowRegistrationValue>
<d2p1:ShadowSPSiteColumnName>String</d2p1:ShadowSPSiteColumnName>
<d2p1:ShadowSPSiteColumnRegistrationValue>String</d2p1:ShadowSPSiteColumnRegistrationValue>
</d2p1:MetaDataField>
</MetaData>
<NavigationPath>String</NavigationPath>
<RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
<SubDocumentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SubDocumentIDs>
</UploadFile>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UploadFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DMS.Operations"> <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId> <DocumentNr>String</DocumentNr> <DocumentUploadId>0</DocumentUploadId> <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.Core.Diagnostics.Interfaces"> <d2p1:InformationMessageBase i:nil="true" /> </Messages> </UploadFileResponse>