GET api/role/{id}/documentfromplaceholder?placeholderType={placeholderType}&placeholderSourceType={placeholderSourceType}&groupId={groupId}&documentSubType={documentSubType}

Get a single DocumentPlaceholder which is the 'slot' the particular document of type+source exists within.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Role id

integer

Required

placeholderType

Which type of document placeholder 'slot' is this

string

Required

placeholderSourceType

Where did the document come from to fit into the placeholder 'slot'

string

Required

groupId

Optional group id to filter placeholder for a specific group relating to this role

integer

None.

documentSubType

Document sub type to filter by in the document placeholder.

Dezrez.Rezi.Domain.Enums.DocumentSubType

Default value is TenancyAgreement

Body Parameters

None.

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Media.Query.DocumentPlaceholderDataContract
NameDescriptionTypeAdditional information
Description

string

None.

DocumentPlaceholderType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

DocumentPlaceholderSourceType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

Document

Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract

None.

DocumentType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

DocumentSubType

Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

GroupId

integer

None.

LastUpdated

date

None.

CreatedDate

date

None.

CreatedBy

Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Description": "sample string 1",
  "DocumentPlaceholderType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DocumentPlaceholderSourceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Document": {
    "Url": "sample string 1",
    "RequiresAuthentication": true,
    "ExpiryDate": "2024-10-08T10:06:20.1894949Z",
    "FileStream": null,
    "Tags": [
      {
        "Name": "sample string 1",
        "SystemStatusName": "sample string 2",
        "TagType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Id": 3
      },
      {
        "Name": "sample string 1",
        "SystemStatusName": "sample string 2",
        "TagType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Id": 3
      }
    ],
    "DocumentType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "DocumentSubType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FileName": "sample string 3",
    "ContentType": "sample string 4",
    "FileExtension": "sample string 5",
    "Description": "sample string 6",
    "FileSize": "sample string 7",
    "CreatedDate": "2024-10-08T10:06:20.1894949Z",
    "CreatedBy": {
      "Initials": "sample string 1",
      "ContactName": "sample string 2",
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 6",
      "Id": 7
    },
    "Id": 9
  },
  "DocumentType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DocumentSubType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "GroupId": 1,
  "LastUpdated": "2024-10-08T10:06:20.1894949Z",
  "CreatedDate": "2024-10-08T10:06:20.1894949Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 3
}