POST api/FileAssistant/Subcontracts/{subcontractId}/Fewo/{fewoId}/SignedDocuments

Create a fewo signed document.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subcontractId

Subcontract identifier.

integer

Required

fewoId

Fewo identifier.

integer

Required

Body Parameters

FewoCreateSignedDocumentDto
NameDescriptionTypeAdditional information
FewoVersionId

integer

None.

Title

string

None.

BaseSiteActionsTypeId

BaseSiteActionsTypeId

None.

IsSigned

boolean

None.

Files

Collection of DocumentBasicInfoDto

None.

Request Formats

application/json, text/json

Sample:
{
  "fewoVersionId": 1,
  "title": "sample string 2",
  "baseSiteActionsTypeId": 1,
  "isSigned": true,
  "files": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ]
}

text/html

Sample:
{"fewoVersionId":1,"title":"sample string 2","baseSiteActionsTypeId":1,"isSigned":true,"files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}]}

application/xml, text/xml

Sample:
<FewoCreateSignedDocumentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.FewoAgg">
  <BaseSiteActionsTypeId>OnlyDataBase</BaseSiteActionsTypeId>
  <FewoVersionId>1</FewoVersionId>
  <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>
  <IsSigned>true</IsSigned>
  <Title>sample string 2</Title>
</FewoCreateSignedDocumentDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FewoToSignDocumentationDto
NameDescriptionTypeAdditional information
Id

integer

None.

FewoId

integer

None.

FewoVersionId

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.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "fewoId": 2,
  "fewoVersionId": 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
}

text/html

Sample:
{"id":1,"fewoId":2,"fewoVersionId":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}

application/xml, text/xml

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