DigiOffice Gateway Web 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
import Foundation
import ServiceStack

/**
* Get the details of a document by reference number
*/
// @Api(Description="Get the details of a document by reference number")
public class GetDocumentByNumber : Codable
{
    public var number:String?
    public var version:String?

    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(){}
}

Swift 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: digiofficeapigateway.deltares.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,"DirectUrl":"String","AllowDigitalSigningOnlyOnPrimaryVersions":false,"IsPrimaryVersion":false,"FileExtension":"String","CustomProperties":{"String":{}}}