| POST | /api/DMS/UploadFile |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DMS.Operations
Imports IDB.API.DMS
Imports IDB.Diagnostics
Imports IDB.Core.Diagnostics.Interfaces
Imports IDB.Core.Diagnostics
Namespace Global
Namespace IDB.API.DMS
<DataContract>
Public Partial Class MetaDataField
<DataMember>
Public Overridable Property ID As Nullable(Of Guid)
<DataMember>
Public Overridable Property DocumentVeldID As Nullable(Of Guid)
<DataMember>
Public Overridable Property Name As String
<DataMember>
Public Overridable Property Label As String
<DataMember>
Public Overridable Property Datatype As String
<DataMember>
Public Overridable Property PrintLabel As String
<DataMember>
Public Overridable Property Entity As String
<DataMember>
Public Overridable Property PrintValue As String
<DataMember>
Public Overridable Property RegistrationValue As String
<DataMember>
Public Overridable Property SPSiteColumnName As String
<DataMember>
Public Overridable Property ShadowName As String
<DataMember>
Public Overridable Property ShadowDatatype As String
<DataMember>
Public Overridable Property ShadowSPSiteColumnName As String
<DataMember>
Public Overridable Property ShadowSPSiteColumnRegistrationValue As String
<DataMember>
Public Overridable Property ShadowRegistrationValue As String
<DataMember>
Public Overridable Property IsKeyField As Boolean
<DataMember>
Public Overridable Property KopierenBijNieuweVersie As Boolean
End Class
End Namespace
Namespace IDB.API.DMS.Operations
Public Partial Class UploadFile
Public Sub New()
MetaData = New List(Of MetaDataField)
SubDocumentIDs = New List(Of Guid)
End Sub
Public Overridable Property RegistrationProfileID As Guid
Public Overridable Property NavigationPath As String
Public Overridable Property FileName As String
Public Overridable Property Description As String
Public Overridable Property DocumentUpload As Boolean
Public Overridable Property MetaData As List(Of MetaDataField)
Public Overridable Property DocumentID As Nullable(Of Guid)
Public Overridable Property HoofdDocumentID As Nullable(Of Guid)
Public Overridable Property SubDocumentIDs As List(Of Guid)
End Class
<DataContract>
Public Partial Class UploadFileResponse
<DataMember>
Public Overridable Property DocumentId As Nullable(Of Guid)
<DataMember>
Public Overridable Property DocumentUploadId As Nullable(Of Integer)
<DataMember>
Public Overridable Property DocumentNr As String
<DataMember>
Public Overridable Property Messages As InformationMessages
End Class
End Namespace
Namespace IDB.Core.Diagnostics
Public Enum MessageType
Information = 1
Warning = 2
[Error] = 3
Success = 4
End Enum
End Namespace
Namespace IDB.Core.Diagnostics.Interfaces
Public Partial Class InformationMessageBase
Implements IInformationMessage
Public Overridable Property Type As MessageType
Public Overridable Property Summary As String
Public Overridable Property FullMessage As String
Public Overridable Property FieldName As String
Public Overridable Property KeepOpen As Boolean
End Class
End Namespace
Namespace IDB.Diagnostics
Public Partial Class InformationMessages
Inherits List(Of InformationMessageBase)
Implements IInformationMessages
End Class
End Namespace
End Namespace
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>