DigiOffice Gateway Web Services

<back to all web services

GetDocumentByFileUrl

Requires Authentication
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetDocumentByFileUrl
{
    var FileUrl:String? = null
}

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

Kotlin GetDocumentByFileUrl 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 /xml/reply/GetDocumentByFileUrl HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentByFileUrl xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <FileUrl>String</FileUrl>
</GetDocumentByFileUrl>
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>
  <InternalNumber>String</InternalNumber>
  <IsCorporateIdentity>false</IsCorporateIdentity>
  <IsFavorite>false</IsFavorite>
  <IsFrozen>false</IsFrozen>
  <IsPrimaryVersion>false</IsPrimaryVersion>
  <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>