POST api/role/{id}/setdocumentplaceholder

Set Placeholder Document. Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the requested resource.	integer	Required

Body Parameters

The set placeholder document data contract supplied with the request.

SetPlaceholderDocumentDataContract

Name	Description	Type	Additional information
PlaceholderType	The placeholder type value.	EnumDataContract	None.
PlaceholderSourceType	The placeholder source type value.	EnumDataContract	None.
GroupId	The unique identifier of the related group resource.	integer	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "PlaceholderType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "PlaceholderSourceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "GroupId": 1,
  "Id": 1
}

Response Information

Resource Description

The response returned after the operation completes.

DocumentPlaceholderDataContract

Name	Description	Type	Additional information
Description	The description value.	string	None.
DocumentPlaceholderType	The document placeholder type value.	EnumDataContract	None.
DocumentPlaceholderSourceType	The document placeholder source type value.	EnumDataContract	None.
Document	The document value.	DocumentDataContract	None.
DocumentType	The document type value.	EnumDataContract	None.
DocumentSubType	The document sub type value.	EnumDataContract	None.
GroupId	The unique identifier of the related group resource.	integer	None.
LastUpdated	The last updated, expressed as a date and time.	date	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
CreatedBy	The created by value.	CreatedByDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.