DigiOffice Gateway Web Services

GetDocumentByNumber

Get the details of a document by reference number

The following routes are available for this service:
POST	/api/documents/number

**GetDocumentByNumber** Parameters:
Name	Parameter	Data Type	Required	Description
Number	body	string	No
Version	body	string	No

**Document** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid	No
RootDocumentID	form	Guid	No
RegistrationprofileID	form	Guid	No
Title	form	string	No
FullTitle	form	string	No
Number	form	string	No
Version	form	string	No
ExternalNumber	form	string	No
ExternalVersion	form	string	No
InternalNumber	form	string	No
InternalInvoiceNumber	form	string	No
PersonID	form	int	No
RelationID	form	int	No
RelationTitle	form	string	No
ProjectID	form	int	No
ProjectTitle	form	string	No
Extension	form	string	No
Date	form	DateTime?	No
CommentsCount	form	int	No
HasComments	form	bool	No
HasPreview	form	bool	No
ExtraField	form	string	No
IsFavorite	form	bool	No
DocumentcategoryText	form	string	No
FileSize	form	long?	No
FileDate	form	DateTime?	No
Hash	form	string	No
HashType	form	string	No
FileUrl	form	string	No
StandardDocumentUrl	form	string	No
IsCorporateIdentity	form	bool	No
UserTitle	form	string	No
IsFrozen	form	bool	No
InternalCompanyID	form	int	No
DirectUrl	form	string	No
AllowDigitalSigningOnlyOnPrimaryVersions	form	bool	No
IsPrimaryVersion	form	bool	No
FileExtension	form	string	No
CustomProperties	form	Dictionary<string, Object>	No

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

<GetDocumentByNumber xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <Number>String</Number>
  <Version>String</Version>
</GetDocumentByNumber>

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>