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
| Name | Description | Type | Additional 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. |
DocumentSubType |
Default value is TenancyAgreement |
Body Parameters
None.
Response Information
Resource Description
DocumentPlaceholderDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Description | string |
None. |
|
| DocumentPlaceholderType | EnumDataContract |
None. |
|
| DocumentPlaceholderSourceType | EnumDataContract |
None. |
|
| Document | DocumentDataContract |
None. |
|
| DocumentType | EnumDataContract |
None. |
|
| DocumentSubType | EnumDataContract |
None. |
|
| GroupId | integer |
None. |
|
| LastUpdated | date |
None. |
|
| CreatedDate | date |
None. |
|
| CreatedBy | CreatedByDataContract |
None. |
|
| Id | integer |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.