| POST | /api/DMS/UploadFile |
|---|
namespace IDB.API.DMS
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type MetaDataField() =
[<DataMember>]
member val ID:Nullable<Guid> = new Nullable<Guid>() with get,set
[<DataMember>]
member val DocumentVeldID:Nullable<Guid> = new Nullable<Guid>() with get,set
[<DataMember>]
member val Name:String = null with get,set
[<DataMember>]
member val Label:String = null with get,set
[<DataMember>]
member val Datatype:String = null with get,set
[<DataMember>]
member val PrintLabel:String = null with get,set
[<DataMember>]
member val Entity:String = null with get,set
[<DataMember>]
member val PrintValue:String = null with get,set
[<DataMember>]
member val RegistrationValue:String = null with get,set
[<DataMember>]
member val SPSiteColumnName:String = null with get,set
[<DataMember>]
member val ShadowName:String = null with get,set
[<DataMember>]
member val ShadowDatatype:String = null with get,set
[<DataMember>]
member val ShadowSPSiteColumnName:String = null with get,set
[<DataMember>]
member val ShadowSPSiteColumnRegistrationValue:String = null with get,set
[<DataMember>]
member val ShadowRegistrationValue:String = null with get,set
[<DataMember>]
member val IsKeyField:Boolean = new Boolean() with get,set
[<DataMember>]
member val KopierenBijNieuweVersie:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type UploadFile() =
member val RegistrationProfileID:Guid = new Guid() with get,set
member val NavigationPath:String = null with get,set
member val FileName:String = null with get,set
member val Description:String = null with get,set
member val DocumentUpload:Boolean = new Boolean() with get,set
member val MetaData:ResizeArray<MetaDataField> = new ResizeArray<MetaDataField>() with get,set
member val DocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
member val HoofdDocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
member val SubDocumentIDs:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
type MessageType =
| Information = 1
| Warning = 2
| Error = 3
| Success = 4
[<AllowNullLiteral>]
type InformationMessageBase() =
member val Type:MessageType = new MessageType() with get,set
member val Summary:String = null with get,set
member val FullMessage:String = null with get,set
member val FieldName:String = null with get,set
member val KeepOpen:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type InformationMessages() =
inherit ResizeArray<InformationMessageBase>()
[<DataContract>]
[<AllowNullLiteral>]
type UploadFileResponse() =
[<DataMember>]
member val DocumentId:Nullable<Guid> = new Nullable<Guid>() with get,set
[<DataMember>]
member val DocumentUploadId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember>]
member val DocumentNr:String = null with get,set
[<DataMember>]
member val Messages:InformationMessages = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
NavigationPath: String,
FileName: String,
Description: String,
DocumentUpload: False,
MetaData:
[
{
ID: 00000000-0000-0000-0000-000000000000,
DocumentVeldID: 00000000-0000-0000-0000-000000000000,
Name: String,
Label: String,
Datatype: String,
PrintLabel: String,
Entity: String,
PrintValue: String,
RegistrationValue: String,
SPSiteColumnName: String,
ShadowName: String,
ShadowDatatype: String,
ShadowSPSiteColumnName: String,
ShadowSPSiteColumnRegistrationValue: String,
ShadowRegistrationValue: String,
IsKeyField: False,
KopierenBijNieuweVersie: False
}
],
DocumentID: 00000000-0000-0000-0000-000000000000,
HoofdDocumentID: 00000000-0000-0000-0000-000000000000,
SubDocumentIDs:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
DocumentId: 00000000-0000-0000-0000-000000000000,
DocumentUploadId: 0,
DocumentNr: String,
Messages:
[
{
}
]
}