DigiOffice Gateway Web Services

GetDocumentByNumber

Get the details of a document by reference number

The following routes are available for this service:
POST	/api/documents/number

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get the details of a document by reference number
*/
@Api(Description="Get the details of a document by reference number")
open class GetDocumentByNumber
{
    open var Number:String? = null
    open var Version:String? = null
}

open class Document : ICustomProperties
{
    open var ID:UUID? = null
    open var RootDocumentID:UUID? = null
    open var RegistrationprofileID:UUID? = null
    open var Title:String? = null
    open var FullTitle:String? = null
    open var Number:String? = null
    open var Version:String? = null
    open var ExternalNumber:String? = null
    open var ExternalVersion:String? = null
    open var InternalNumber:String? = null
    open var InternalInvoiceNumber:String? = null
    open var PersonID:Int? = null
    open var RelationID:Int? = null
    open var RelationTitle:String? = null
    open var ProjectID:Int? = null
    open var ProjectTitle:String? = null
    open var Extension:String? = null
    open var Date:Date? = null
    open var CommentsCount:Int? = null
    open var HasComments:Boolean? = null
    open var HasPreview:Boolean? = null
    open var ExtraField:String? = null
    open var IsFavorite:Boolean? = null
    open var DocumentcategoryText:String? = null
    open var FileSize:Long? = null
    open var FileDate:Date? = null
    open var Hash:String? = null
    open var HashType:String? = null
    open var FileUrl:String? = null
    open var StandardDocumentUrl:String? = null
    open var IsCorporateIdentity:Boolean? = null
    open var UserTitle:String? = null
    open var IsFrozen:Boolean? = null
    open var InternalCompanyID:Int? = null
    open var InternalLocationID:Int? = null
    open var LanguageID:Int? = null
    open var DirectUrl:String? = null
    open var AllowDigitalSigningOnlyOnPrimaryVersions:Boolean? = null
    open var IsPrimaryVersion:Boolean? = null
    open var FileExtension:String? = null
    override var CustomProperties:HashMap<String,Object>? = null
}

Kotlin GetDocumentByNumber DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/documents/number HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentByNumber xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <Number>String</Number>
  <Version>String</Version>
</GetDocumentByNumber>

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>
  <InternalLocationID>0</InternalLocationID>
  <InternalNumber>String</InternalNumber>
  <IsCorporateIdentity>false</IsCorporateIdentity>
  <IsFavorite>false</IsFavorite>
  <IsFrozen>false</IsFrozen>
  <IsPrimaryVersion>false</IsPrimaryVersion>
  <LanguageID>0</LanguageID>
  <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>