POST api/document/upload

Upload a document.

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Media.Commands.DocumentSaveCommandDataContract

Name	Type	Additional information
IsPublic	boolean	None.
ExpiryDate	date	None.
StartDate	date	None.
DocumentPlaceholderType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
DocumentPlaceholderSourceType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
FileStream	System.IO.Stream	None.
Tags	Collection of Dezrez.Core.DataContracts.External.Api.System.TagDataContract	None.
DocumentType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
DocumentSubType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
FileName	string	None.
ContentType	string	None.
FileExtension	string	None.
Description	string	None.
FileSize	string	None.
CreatedDate	date	None.
CreatedBy	Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "IsPublic": true,
  "ExpiryDate": "2024-11-21T09:30:16.8098392Z",
  "StartDate": "2024-11-21T09:30:16.8098392Z",
  "DocumentPlaceholderType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DocumentPlaceholderSourceType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "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 2",
  "ContentType": "sample string 3",
  "FileExtension": "sample string 4",
  "Description": "sample string 5",
  "FileSize": "sample string 6",
  "CreatedDate": "2024-11-21T09:30:16.8098392Z",
  "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": 8
}

Response Information

Resource Description

The document

System.Net.Http.HttpResponseMessage

Name	Type	Additional information
Version	System.Version	None.
Content	System.Net.Http.HttpContent	None.
StatusCode	System.Net.HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	System.Net.Http.HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.