POST api/Supplements/{supplementId}/Documents

Create supplement document

Request Information

URI Parameters

NameDescriptionTypeAdditional information
supplementId

integer

Required

Body Parameters

CreateSupplementDocumentDto
NameDescriptionTypeAdditional information
Version

integer

None.

SuplementVersionId

integer

None.

Title

string

None.

FolderPath

string

None.

BaseSiteActionsTypeId

BaseSiteActionsTypeId

None.

Files

Collection of DocumentBasicInfoDto

None.

Request Formats

application/json, text/json

Sample:
{
  "version": 1,
  "suplementVersionId": 1,
  "title": "sample string 2",
  "folderPath": "sample string 3",
  "baseSiteActionsTypeId": 1,
  "files": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ]
}

text/html

Sample:
{"version":1,"suplementVersionId":1,"title":"sample string 2","folderPath":"sample string 3","baseSiteActionsTypeId":1,"files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}]}

application/xml, text/xml

Sample:
<CreateSupplementDocumentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SuplementAgg">
  <BaseSiteActionsTypeId>OnlyDataBase</BaseSiteActionsTypeId>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.Dtos.DocumentAgg">
    <d2p1:DocumentBasicInfoDto>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:DocumentBasicInfoDto>
    <d2p1:DocumentBasicInfoDto>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:DocumentBasicInfoDto>
  </Files>
  <FolderPath>sample string 3</FolderPath>
  <SuplementVersionId>1</SuplementVersionId>
  <Title>sample string 2</Title>
  <Version>1</Version>
</CreateSupplementDocumentDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiDataResultOfBoolean
NameDescriptionTypeAdditional information
Data

boolean

None.

Success

boolean

None.

Message

string

None.

Errors

Collection of CustomError

None.

Warnings

Collection of string

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.