| GET POST | /api/documents/{DocumentID} |
|---|
import Foundation
import ServiceStack
public class GetDocumentDetails : Codable
{
public var documentID:String?
public var includeCustomProperties:Bool?
required public init(){}
}
public class Document : ICustomProperties, Codable
{
public var id:String?
public var rootDocumentID:String?
public var registrationprofileID:String?
public var title:String?
public var fullTitle:String?
public var number:String?
public var version:String?
public var externalNumber:String?
public var externalVersion:String?
public var internalNumber:String?
public var internalInvoiceNumber:String?
public var personID:Int?
public var relationID:Int?
public var relationTitle:String?
public var projectID:Int?
public var projectTitle:String?
public var `extension`:String?
public var date:Date?
public var commentsCount:Int?
public var hasComments:Bool?
public var hasPreview:Bool?
public var extraField:String?
public var isFavorite:Bool?
public var documentcategoryText:String?
public var fileSize:Int?
public var fileDate:Date?
public var hash:String?
public var hashType:String?
public var fileUrl:String?
public var standardDocumentUrl:String?
public var isCorporateIdentity:Bool?
public var userTitle:String?
public var isFrozen:Bool?
public var internalCompanyID:Int?
public var directUrl:String?
public var allowDigitalSigningOnlyOnPrimaryVersions:Bool?
public var isPrimaryVersion:Bool?
public var fileExtension:String?
public var customProperties:[String:Object] = [:]
required public init(){}
}
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>