DigiOffice Gateway Web Services

<back to all web services

GetDocumentDetails

Requires Authentication
The following routes are available for this service:
GET POST/api/documents/{DocumentID}
"use strict";
export class Document {
    /** @param {{ID?:string,RootDocumentID?:string,RegistrationprofileID?:string,Title?:string,FullTitle?:string,Number?:string,Version?:string,ExternalNumber?:string,ExternalVersion?:string,InternalNumber?:string,InternalInvoiceNumber?:string,PersonID?:number,RelationID?:number,RelationTitle?:string,ProjectID?:number,ProjectTitle?:string,Extension?:string,Date?:string,CommentsCount?:number,HasComments?:boolean,HasPreview?:boolean,ExtraField?:string,IsFavorite?:boolean,DocumentcategoryText?:string,FileSize?:number,FileDate?:string,Hash?:string,HashType?:string,FileUrl?:string,StandardDocumentUrl?:string,IsCorporateIdentity?:boolean,UserTitle?:string,IsFrozen?:boolean,InternalCompanyID?:number,InternalLocationID?:number,LanguageID?:number,DirectUrl?:string,AllowDigitalSigningOnlyOnPrimaryVersions?:boolean,IsPrimaryVersion?:boolean,FileExtension?:string,CustomProperties?:{ [index:string]: Object; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    RootDocumentID;
    /** @type {string} */
    RegistrationprofileID;
    /** @type {string} */
    Title;
    /** @type {string} */
    FullTitle;
    /** @type {string} */
    Number;
    /** @type {string} */
    Version;
    /** @type {string} */
    ExternalNumber;
    /** @type {string} */
    ExternalVersion;
    /** @type {string} */
    InternalNumber;
    /** @type {string} */
    InternalInvoiceNumber;
    /** @type {number} */
    PersonID;
    /** @type {number} */
    RelationID;
    /** @type {string} */
    RelationTitle;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ProjectTitle;
    /** @type {string} */
    Extension;
    /** @type {?string} */
    Date;
    /** @type {number} */
    CommentsCount;
    /** @type {boolean} */
    HasComments;
    /** @type {boolean} */
    HasPreview;
    /** @type {string} */
    ExtraField;
    /** @type {boolean} */
    IsFavorite;
    /** @type {string} */
    DocumentcategoryText;
    /** @type {?number} */
    FileSize;
    /** @type {?string} */
    FileDate;
    /** @type {string} */
    Hash;
    /** @type {string} */
    HashType;
    /** @type {string} */
    FileUrl;
    /** @type {string} */
    StandardDocumentUrl;
    /** @type {boolean} */
    IsCorporateIdentity;
    /** @type {string} */
    UserTitle;
    /** @type {boolean} */
    IsFrozen;
    /** @type {number} */
    InternalCompanyID;
    /** @type {?number} */
    InternalLocationID;
    /** @type {?number} */
    LanguageID;
    /** @type {string} */
    DirectUrl;
    /** @type {boolean} */
    AllowDigitalSigningOnlyOnPrimaryVersions;
    /** @type {boolean} */
    IsPrimaryVersion;
    /** @type {string} */
    FileExtension;
    /** @type {{ [index:string]: Object; }} */
    CustomProperties;
}
export class GetDocumentDetails {
    /** @param {{DocumentID?:string,IncludeCustomProperties?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentID;
    /** @type {boolean} */
    IncludeCustomProperties;
}

JavaScript GetDocumentDetails 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/{DocumentID} HTTP/1.1 
Host: test-dogw.klokgroep.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>
  <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>