GET POST | /api/documents/{DocumentID} |
---|
namespace IDB.API.DTO.Document
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type Document() =
member val ID:Guid = new Guid() with get,set
member val RootDocumentID:Guid = new Guid() with get,set
member val RegistrationprofileID:Guid = new Guid() with get,set
member val Title:String = null with get,set
member val FullTitle:String = null with get,set
member val Number:String = null with get,set
member val Version:String = null with get,set
member val ExternalNumber:String = null with get,set
member val ExternalVersion:String = null with get,set
member val InternalNumber:String = null with get,set
member val InternalInvoiceNumber:String = null with get,set
member val PersonID:Int32 = new Int32() with get,set
member val RelationID:Int32 = new Int32() with get,set
member val RelationTitle:String = null with get,set
member val ProjectID:Int32 = new Int32() with get,set
member val ProjectTitle:String = null with get,set
member val Extension:String = null with get,set
member val Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CommentsCount:Int32 = new Int32() with get,set
member val HasComments:Boolean = new Boolean() with get,set
member val HasPreview:Boolean = new Boolean() with get,set
member val ExtraField:String = null with get,set
member val IsFavorite:Boolean = new Boolean() with get,set
member val DocumentcategoryText:String = null with get,set
member val FileSize:Nullable<Int64> = new Nullable<Int64>() with get,set
member val FileDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Hash:String = null with get,set
member val HashType:String = null with get,set
member val FileUrl:String = null with get,set
member val StandardDocumentUrl:String = null with get,set
member val IsCorporateIdentity:Boolean = new Boolean() with get,set
member val UserTitle:String = null with get,set
member val IsFrozen:Boolean = new Boolean() with get,set
member val InternalCompanyID:Int32 = new Int32() with get,set
member val DirectUrl:String = null with get,set
member val AllowDigitalSigningOnlyOnPrimaryVersions:Boolean = new Boolean() with get,set
member val IsPrimaryVersion:Boolean = new Boolean() with get,set
member val FileExtension:String = null with get,set
member val CustomProperties:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
[<AllowNullLiteral>]
type GetDocumentDetails() =
member val DocumentID:Guid = new Guid() with get,set
member val IncludeCustomProperties:Boolean = new Boolean() with get,set
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/documents/{DocumentID} HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetDocumentDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
<DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
<IncludeCustomProperties>false</IncludeCustomProperties>
</GetDocumentDetails>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document"> <AllowDigitalSigningOnlyOnPrimaryVersions>false</AllowDigitalSigningOnlyOnPrimaryVersions> <CommentsCount>0</CommentsCount> <CustomProperties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringanyType> <d2p1:Key>String</d2p1:Key> <d2p1:Value /> </d2p1:KeyValueOfstringanyType> </CustomProperties> <Date>0001-01-01T00:00:00</Date> <DirectUrl>String</DirectUrl> <DocumentcategoryText>String</DocumentcategoryText> <Extension>String</Extension> <ExternalNumber>String</ExternalNumber> <ExternalVersion>String</ExternalVersion> <ExtraField>String</ExtraField> <FileDate>0001-01-01T00:00:00</FileDate> <FileExtension>String</FileExtension> <FileSize>0</FileSize> <FileUrl>String</FileUrl> <FullTitle>String</FullTitle> <HasPreview>false</HasPreview> <Hash>String</Hash> <HashType>String</HashType> <ID>00000000-0000-0000-0000-000000000000</ID> <InternalCompanyID>0</InternalCompanyID> <InternalInvoiceNumber>String</InternalInvoiceNumber> <InternalNumber>String</InternalNumber> <IsCorporateIdentity>false</IsCorporateIdentity> <IsFavorite>false</IsFavorite> <IsFrozen>false</IsFrozen> <IsPrimaryVersion>false</IsPrimaryVersion> <Number>String</Number> <PersonID>0</PersonID> <ProjectID>0</ProjectID> <ProjectTitle>String</ProjectTitle> <RegistrationprofileID>00000000-0000-0000-0000-000000000000</RegistrationprofileID> <RelationID>0</RelationID> <RelationTitle>String</RelationTitle> <RootDocumentID>00000000-0000-0000-0000-000000000000</RootDocumentID> <StandardDocumentUrl>String</StandardDocumentUrl> <Title>String</Title> <UserTitle>String</UserTitle> <Version>String</Version> </Document>