POST | /api/internal/document/referenceddocumentsreadbyfolderid |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FolderID | body | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AuthSessionKey | form | string | No | |
AdditionalInfo | form | List<ItemNameValue> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PropertyName | form | string | No | |
PropertyValue | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReferenceList | form | DocumentReference | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UiErrorMessage | form | string | No | |
UiDevErrorMessage | form | string | No | |
ErrorOccured | form | bool | No | |
LogMessageType | form | ErrorMessageType | No | |
ResponseStatus | form | ResponseStatus | No | |
NumberOfRecordsEffected | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentList | form | List<FolderDocument> | No | |
FolderList | form | List<Folder> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FolderId | form | int | No | |
DocumentId | form | int | No | |
DocumentNumber | form | string | No | |
DocumentDiscipline | form | int | No | |
DocumentDisciplineName | form | string | No | |
DocumentCSI | form | string | No | |
DocumentType | form | int | No | |
DocumentTypeName | form | string | No | |
DocumentStatus | form | int | No | |
DocumentStatusName | form | string | No | |
DocumentIssue | form | string | No | |
DocumentIssueDate | form | DateTime | No | |
EstimatedFileSize | form | int | No | |
UploadedFileName | form | string | No | |
UploadedFileSize | form | int | No | |
AllFilesSize | form | int | No | |
DocumentUpdateDate | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FolderId | form | int | No | |
FolderName | form | string | No | |
FolderDescription | form | string | No | |
FolderParentId | form | int? | No | |
FolderType | form | int | No | |
FolderTypeName | form | string | No | |
FolderReferenceId | form | int | No | |
FolderProjectId | form | int | No | |
FolderSorting | form | int | No | |
AccessByList | form | int | No | |
CreatedByFullName | form | string | No | |
CreatedBy | form | int | No | |
CreatedDate | form | DateTime | No | |
UpdatedByFullName | form | string | No | |
UpdatedBy | form | int | No | |
UpdatedDate | form | DateTime | No | |
Updator | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserCanModify | form | bool | No | |
UserCanDelete | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/ReferencedDocumentsReadByFolderIDRequest HTTP/1.1
Host: api.sagecpc.com
Content-Type: application/json
Content-Length: length
{"folderID":0,"authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"referenceList":{"documentList":[{"folderId":0,"documentId":0,"documentNumber":"String","documentDiscipline":0,"documentDisciplineName":"String","documentCSI":"String","documentType":0,"documentTypeName":"String","documentStatus":0,"documentStatusName":"String","documentIssue":"String","documentIssueDate":"\/Date(-62135596800000-0000)\/","estimatedFileSize":0,"uploadedFileName":"String","uploadedFileSize":0,"allFilesSize":0,"documentUpdateDate":"\/Date(-62135596800000-0000)\/"}],"folderList":[{"folderId":0,"folderName":"String","folderDescription":"String","folderParentId":0,"folderType":0,"folderTypeName":"String","folderReferenceId":0,"folderProjectId":0,"folderSorting":0,"accessByList":0,"createdByFullName":"String","createdBy":0,"createdDate":"\/Date(-62135596800000-0000)\/","updatedByFullName":"String","updatedBy":0,"updatedDate":"\/Date(-62135596800000-0000)\/","updator":0,"userCanModify":false,"userCanDelete":false}]},"uiErrorMessage":"String","uiDevErrorMessage":"String","errorOccured":false,"logMessageType":"DEBUG","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"numberOfRecordsEffected":0}