DigiOffice Gateway Web Services

GetDocumentDetails

The following routes are available for this service:
GET POST	/api/documents/{DocumentID}


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 GetDocumentDetails
{
    public DocumentID?: string;
    public IncludeCustomProperties?: boolean;

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

TypeScript 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: digiofficeapigateway.deltares.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>
  <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>