POST api/role/{id}/setdocumentplaceholder

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

SetPlaceholderDocumentDataContract

Name	Type	Additional information
PlaceholderType	EnumDataContract	None.
PlaceholderSourceType	EnumDataContract	None.
GroupId	integer	None.
Id	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

DocumentPlaceholderDataContract

Name	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, 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": "2025-06-25T09:50:24.1072173Z",
    "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
      }
    ],
    "ApprovalStatus": {
      "Status": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Reason": "sample string 1",
      "LastUpdatedBy": {
        "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": 2
    },
    "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": "2025-06-25T09:50:24.1072173Z",
    "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": "2025-06-25T09:50:24.1072173Z",
  "CreatedDate": "2025-06-25T09:50:24.1072173Z",
  "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
}