POST api/FileAssistant/Subcontract/{subcontractId}/Sfr/{sfrId}/Documents

Create SFR document

Request Information

URI Parameters

Name	Description	Type	Additional information
subcontractId		integer	Required
sfrId		integer	Required

Body Parameters

CreateSfrDocumentationDto

Name	Type	Additional information
Version	integer	None.
SfrVersionId	integer	None.
Title	string	None.
BaseSiteActionsTypeId	BaseSiteActionsTypeId	None.
Files	Collection of DocumentBasicInfoDto	None.

Request Formats

application/json, text/json

Sample:

{
  "version": 1,
  "sfrVersionId": 1,
  "title": "sample string 2",
  "baseSiteActionsTypeId": 1,
  "files": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ]
}

text/html

Sample:

{"version":1,"sfrVersionId":1,"title":"sample string 2","baseSiteActionsTypeId":1,"files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}]}

application/xml, text/xml

Sample:

<CreateSfrDocumentationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SfrAgg">
  <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>
  <SfrVersionId>1</SfrVersionId>
  <Title>sample string 2</Title>
  <Version>1</Version>
</CreateSfrDocumentationDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SfrDocumentDto

Name	Type	Additional information
Id	integer	None.
SfrId	integer	None.
SfrVersionId	integer	None.
Title	string	None.
VersionToSign	integer	None.
Signed	boolean	None.
SignedVersion	integer	None.
DocumentId	integer	None.
FileName	string	None.
FileExtension	string	None.
VersionNumber	integer	None.
FolderPath	string	None.
FileSize	integer	None.
FileSizeKB	decimal number	None.
FileSizeMB	decimal number	None.
CreatedBy	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "sfrId": 2,
  "sfrVersionId": 3,
  "title": "sample string 4",
  "versionToSign": 5,
  "signed": true,
  "signedVersion": 7,
  "documentId": 8,
  "fileName": "sample string 9",
  "fileExtension": "sample string 10",
  "versionNumber": 11,
  "folderPath": "sample string 12",
  "fileSize": 1,
  "fileSizeKB": 0.0009765625,
  "fileSizeMB": 9.5367431640625E-07,
  "createdBy": "sample string 13"
}

text/html

Sample:

{"id":1,"sfrId":2,"sfrVersionId":3,"title":"sample string 4","versionToSign":5,"signed":true,"signedVersion":7,"documentId":8,"fileName":"sample string 9","fileExtension":"sample string 10","versionNumber":11,"folderPath":"sample string 12","fileSize":1,"fileSizeKB":0.0009765625,"fileSizeMB":0.00000095367431640625,"createdBy":"sample string 13"}

application/xml, text/xml

Sample:

<SfrDocumentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SfrAgg">
  <CreatedBy>sample string 13</CreatedBy>
  <DocumentId>8</DocumentId>
  <FileExtension>sample string 10</FileExtension>
  <FileName>sample string 9</FileName>
  <FileSize>1</FileSize>
  <FolderPath>sample string 12</FolderPath>
  <Id>1</Id>
  <SfrId>2</SfrId>
  <SfrVersionId>3</SfrVersionId>
  <Signed>true</Signed>
  <SignedVersion>7</SignedVersion>
  <Title>sample string 4</Title>
  <VersionNumber>11</VersionNumber>
  <VersionToSign>5</VersionToSign>
</SfrDocumentDto>