DigiOffice API Services Services

<back to all web services

GetDocumentByNumber

Get the details of a document by reference number

Requires Authentication
The following routes are available for this service:
POST/api/documents/number
"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 GetDocumentByNumber {
    /** @param {{Number?:string,Version?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Number;
    /** @type {string} */
    Version;
}

JavaScript GetDocumentByNumber DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: test-do-services.klokgroep.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Number":"String","Version":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","RegistrationprofileID":"00000000-0000-0000-0000-000000000000","Title":"String","FullTitle":"String","Number":"String","Version":"String","ExternalNumber":"String","ExternalVersion":"String","InternalNumber":"String","InternalInvoiceNumber":"String","PersonID":0,"RelationID":0,"RelationTitle":"String","ProjectID":0,"ProjectTitle":"String","Extension":"String","Date":"0001-01-01T00:00:00.0000000","CommentsCount":0,"HasComments":false,"HasPreview":false,"ExtraField":"String","IsFavorite":false,"DocumentcategoryText":"String","FileSize":0,"FileDate":"0001-01-01T00:00:00.0000000","Hash":"String","HashType":"String","FileUrl":"String","StandardDocumentUrl":"String","IsCorporateIdentity":false,"UserTitle":"String","IsFrozen":false,"InternalCompanyID":0,"InternalLocationID":0,"LanguageID":0,"DirectUrl":"String","AllowDigitalSigningOnlyOnPrimaryVersions":false,"IsPrimaryVersion":false,"FileExtension":"String","CustomProperties":{"String":{}}}