GET api1/Document
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of DocumentDTOName | Description | Type | Additional information |
---|---|---|---|
DocumentID | integer |
None. |
|
ContractID | integer |
None. |
|
Path | string |
None. |
|
FileName | string |
None. |
|
DocumentTypeID | integer |
None. |
|
DocumentNotes | string |
None. |
|
OriginalUser | string |
None. |
|
OriginalDateTime | date |
None. |
|
UpdateUser | string |
None. |
|
UpdateDateTime | date |
None. |
|
documentTypeDTO | DocumentTypeDTO |
None. |
|
OriginalLocation | string |
None. |
|
File | Collection of byte |
None. |
Response Formats
application/json, text/json
Sample:
[ { "DocumentID": 1, "ContractID": 2, "Path": "sample string 3", "FileName": "sample string 4", "DocumentTypeID": 5, "DocumentNotes": "sample string 6", "OriginalUser": "sample string 7", "OriginalDateTime": "2025-03-10T09:13:17.8628483+00:00", "UpdateUser": "sample string 9", "UpdateDateTime": "2025-03-10T09:13:17.8628483+00:00", "documentTypeDTO": { "DocumentTypeID": 1, "Name": "sample string 2" }, "OriginalLocation": "sample string 11", "File": "QEA=" }, { "DocumentID": 1, "ContractID": 2, "Path": "sample string 3", "FileName": "sample string 4", "DocumentTypeID": 5, "DocumentNotes": "sample string 6", "OriginalUser": "sample string 7", "OriginalDateTime": "2025-03-10T09:13:17.8628483+00:00", "UpdateUser": "sample string 9", "UpdateDateTime": "2025-03-10T09:13:17.8628483+00:00", "documentTypeDTO": { "DocumentTypeID": 1, "Name": "sample string 2" }, "OriginalLocation": "sample string 11", "File": "QEA=" } ]
application/xml, text/xml
Sample:
<ArrayOfDocumentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GENEX.Royalty.DTO"> <DocumentDTO> <ContractID>2</ContractID> <DocumentID>1</DocumentID> <DocumentNotes>sample string 6</DocumentNotes> <DocumentTypeID>5</DocumentTypeID> <File>QEA=</File> <FileName>sample string 4</FileName> <OriginalDateTime>2025-03-10T09:13:17.8628483+00:00</OriginalDateTime> <OriginalLocation>sample string 11</OriginalLocation> <OriginalUser>sample string 7</OriginalUser> <Path>sample string 3</Path> <UpdateDateTime>2025-03-10T09:13:17.8628483+00:00</UpdateDateTime> <UpdateUser>sample string 9</UpdateUser> <documentTypeDTO> <DocumentTypeID>1</DocumentTypeID> <Name>sample string 2</Name> </documentTypeDTO> </DocumentDTO> <DocumentDTO> <ContractID>2</ContractID> <DocumentID>1</DocumentID> <DocumentNotes>sample string 6</DocumentNotes> <DocumentTypeID>5</DocumentTypeID> <File>QEA=</File> <FileName>sample string 4</FileName> <OriginalDateTime>2025-03-10T09:13:17.8628483+00:00</OriginalDateTime> <OriginalLocation>sample string 11</OriginalLocation> <OriginalUser>sample string 7</OriginalUser> <Path>sample string 3</Path> <UpdateDateTime>2025-03-10T09:13:17.8628483+00:00</UpdateDateTime> <UpdateUser>sample string 9</UpdateUser> <documentTypeDTO> <DocumentTypeID>1</DocumentTypeID> <Name>sample string 2</Name> </documentTypeDTO> </DocumentDTO> </ArrayOfDocumentDTO>