GET POST | /api/documents/count |
---|
export class RegistrationProfileFieldValue
{
public DocumentFieldID?: string;
public Value?: string;
public ShadowValue?: string;
public IsModifiedByUser?: boolean;
public constructor(init?: Partial<RegistrationProfileFieldValue>) { (Object as any).assign(this, init); }
}
export class GetDocumentsCount
{
public ViewID?: string;
public PageSize?: number;
public PageNumber?: number;
public SearchCriteria?: string;
public ExplorerID?: string;
public Path?: string;
public ExternalNumber?: string;
public ModifiedSince?: string;
public AllVersions?: boolean;
public Archived?: boolean;
public FilterName?: string;
public ProgCode?: string;
public RegistrationProfileFieldID?: string;
public DependableFields?: RegistrationProfileFieldValue[];
public constructor(init?: Partial<GetDocumentsCount>) { (Object as any).assign(this, init); }
}
TypeScript GetDocumentsCount DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documents/count HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetDocumentsCount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
<AllVersions>false</AllVersions>
<Archived>false</Archived>
<DependableFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
<d2p1:RegistrationProfileFieldValue>
<d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
<d2p1:IsModifiedByUser>false</d2p1:IsModifiedByUser>
<d2p1:ShadowValue>String</d2p1:ShadowValue>
<d2p1:Value>String</d2p1:Value>
</d2p1:RegistrationProfileFieldValue>
</DependableFields>
<ExplorerID>00000000-0000-0000-0000-000000000000</ExplorerID>
<ExternalNumber>String</ExternalNumber>
<FilterName>String</FilterName>
<ModifiedSince>0001-01-01T00:00:00</ModifiedSince>
<PageNumber>0</PageNumber>
<PageSize>0</PageSize>
<Path>String</Path>
<ProgCode>String</ProgCode>
<RegistrationProfileFieldID>00000000-0000-0000-0000-000000000000</RegistrationProfileFieldID>
<SearchCriteria>String</SearchCriteria>
<ViewID>00000000-0000-0000-0000-000000000000</ViewID>
</GetDocumentsCount>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</int>