POST api/Projects/{projectId}/SI/{siId}/Versions/{siVersionId}/Documents
Create Site Instruction Document
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| projectId | integer |
Required |
|
| siId | integer |
Required |
|
| siVersionId | integer |
Required |
Body Parameters
CreateSiDocumentDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Title | string |
None. |
|
| BaseSiteActionsTypeId | BaseSiteActionsTypeId |
None. |
|
| Files | Collection of DocumentBasicInfoDto |
None. |
|
| IsSigned | boolean |
None. |
|
| ProjectId | integer |
None. |
|
| SiteInstructionId | integer |
None. |
|
| SiVersionId | integer |
None. |
|
| IsSignedDocument | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"title": "sample string 1",
"baseSiteActionsTypeId": 1,
"files": [
{
"id": 1,
"name": "sample string 2"
},
{
"id": 1,
"name": "sample string 2"
}
],
"isSigned": true,
"projectId": 3,
"siteInstructionId": 4,
"siVersionId": 1,
"isSignedDocument": true
}
text/html
Sample:
{"title":"sample string 1","baseSiteActionsTypeId":1,"files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}],"isSigned":true,"projectId":3,"siteInstructionId":4,"siVersionId":1,"isSignedDocument":true}
application/xml, text/xml
Sample:
<CreateSiDocumentDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SiteInstructionAgg">
<IsSignedDocument>true</IsSignedDocument>
<ProjectId>3</ProjectId>
<SiVersionId>1</SiVersionId>
<SiteInstructionId>4</SiteInstructionId>
<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>
<IsSigned>true</IsSigned>
<Title>sample string 1</Title>
</CreateSiDocumentDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiDataResultOfBoolean| Name | Description | Type | Additional 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.