DigiOffice Gateway Web Services

<back to all web services

GetDocumentByFileUrl

Requires Authentication

export class Document implements ICustomProperties
{
    public ID?: string;
    public RootDocumentID?: string;
    public RegistrationprofileID?: string;
    public Title?: string;
    public FullTitle?: string;
    public Number?: string;
    public Version?: string;
    public ExternalNumber?: string;
    public ExternalVersion?: string;
    public InternalNumber?: string;
    public InternalInvoiceNumber?: string;
    public PersonID?: number;
    public RelationID?: number;
    public RelationTitle?: string;
    public ProjectID?: number;
    public ProjectTitle?: string;
    public Extension?: string;
    public Date?: string;
    public CommentsCount?: number;
    public HasComments?: boolean;
    public HasPreview?: boolean;
    public ExtraField?: string;
    public IsFavorite?: boolean;
    public DocumentcategoryText?: string;
    public FileSize?: number;
    public FileDate?: string;
    public Hash?: string;
    public HashType?: string;
    public FileUrl?: string;
    public StandardDocumentUrl?: string;
    public IsCorporateIdentity?: boolean;
    public UserTitle?: string;
    public IsFrozen?: boolean;
    public InternalCompanyID?: number;
    public DirectUrl?: string;
    public AllowDigitalSigningOnlyOnPrimaryVersions?: boolean;
    public IsPrimaryVersion?: boolean;
    public FileExtension?: string;
    public CustomProperties?: { [index: string]: Object; };

    public constructor(init?: Partial<Document>) { (Object as any).assign(this, init); }
}

export class GetDocumentByFileUrl
{
    public FileUrl?: string;

    public constructor(init?: Partial<GetDocumentByFileUrl>) { (Object as any).assign(this, init); }
}

TypeScript GetDocumentByFileUrl DTOs

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

HTTP + JSV

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

POST /jsv/reply/GetDocumentByFileUrl HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FileUrl: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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-01,
	CommentsCount: 0,
	HasComments: False,
	HasPreview: False,
	ExtraField: String,
	IsFavorite: False,
	DocumentcategoryText: String,
	FileSize: 0,
	FileDate: 0001-01-01,
	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: {}
	}
}