GET api/NE/Documents

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Document
NameDescriptionTypeAdditional information
CreatedBy

integer

None.

CreatedDate

date

None.

DocumentId

integer

None.

DocumentSourceDetails

string

None.

DocumentSourceId

integer

None.

DocumentTypeId

integer

None.

DocumentWorkQueueId

integer

None.

EntityId

integer

None.

EntityNameId

integer

None.

IsDeleted

boolean

None.

ModifiedBy

integer

None.

ModifiedDate

date

None.

Notes

string

None.

PageCount

integer

None.

Path

string

None.

ReceiptDate

date

None.

DocumentSource

DocumentSource

None.

DocumentType

DocumentType

None.

DocumentWorkQueue

DocumentWorkQueue

None.

EntityName

EntityName

None.

CreatedByUser

User

None.

ModifiedByUser

User

None.

DocumentSources

Collection of DocumentSource

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "$type": "NE.Entities.Server.DOC.Document, NE.Entities.Server",
    "CreatedBy": 1,
    "CreatedDate": "2022-08-13T21:58:53.842+00:00",
    "DocumentId": 3,
    "DocumentSourceDetails": "sample string 4",
    "DocumentSourceId": 5,
    "DocumentTypeId": 6,
    "DocumentWorkQueueId": 1,
    "EntityId": 1,
    "EntityNameId": 1,
    "IsDeleted": true,
    "ModifiedBy": 1,
    "ModifiedDate": "2022-08-13T21:58:53.842+00:00",
    "Notes": "sample string 8",
    "PageCount": 9,
    "Path": "sample string 10",
    "ReceiptDate": "2022-08-13T21:58:53.842+00:00",
    "DocumentSource": {
      "$id": "2",
      "$type": "NE.Entities.Server.DOC.DocumentSource, NE.Entities.Server",
      "CodeName": "sample string 1",
      "Description": "sample string 2",
      "DocumentSourceId": 3,
      "Documents": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ]
    },
    "DocumentType": {
      "$id": "3",
      "$type": "NE.Entities.Server.DOC.DocumentType, NE.Entities.Server",
      "CodeName": "sample string 1",
      "Description": "sample string 2",
      "DocumentTypeCategoryId": 3,
      "DocumentTypeId": 4,
      "IsActive": true,
      "DocumentTypeCategory": {
        "$id": "4",
        "$type": "NE.Entities.Server.DOC.DocumentTypeCategory, NE.Entities.Server",
        "CodeName": "sample string 1",
        "Description": "sample string 2",
        "DocumentTypeCategoryId": 3,
        "IsActive": true,
        "DocumentTypes": [
          {
            "$ref": "3"
          },
          {
            "$ref": "3"
          }
        ]
      }
    },
    "DocumentWorkQueue": {
      "$id": "5",
      "$type": "NE.Entities.Server.DOC.DocumentWorkQueue, NE.Entities.Server",
      "CodeName": "sample string 1",
      "Description": "sample string 2",
      "DocumentWorkQueueId": 3,
      "IsActive": true
    },
    "EntityName": {
      "$id": "6",
      "$type": "AHS.Server.Entities.EntityName, AHS.Server",
      "EntityNameId": 1,
      "Description": "sample string 2",
      "CodeName": "sample string 3"
    },
    "CreatedByUser": {
      "$id": "7",
      "$type": "AHS.Server.Entities.User, AHS.Server",
      "UserId": 1,
      "Username": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Email": "sample string 5",
      "IsActive": true,
      "IsSystem": true,
      "IsADBased": true,
      "BusinessUnitId": 9,
      "PermissionIds": [
        1,
        2
      ],
      "FullName": "sample string 3 sample string 4",
      "BusinessUnit": {
        "$id": "8",
        "$type": "AHS.Server.Entities.BusinessUnit, AHS.Server",
        "BusinessUnitId": 1,
        "Description": "sample string 2",
        "IsAHS": true
      }
    },
    "ModifiedByUser": {
      "$ref": "7"
    },
    "DocumentSources": [
      {
        "$ref": "2"
      },
      {
        "$ref": "2"
      }
    ]
  },
  {
    "$ref": "1"
  }
]