PUT api/Subcontracts/{subcontractId}/Npa/{npaId}/CommunicateToSubcontractor

Comunica una NPA al subcontratista, ejecutando el comando de comunicación asociado. Communicates an NPA to the subcontractor by executing the associated communication command.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subcontractId

Identificador del subcontrato al que pertenece la NPA. Identifier of the subcontract the NPA belongs to.

integer

Required

npaId

Identificador de la NPA que se desea comunicar. Identifier of the NPA to be communicated.

integer

Required

Body Parameters

Comando con los datos necesarios para la comunicación; si es nulo, se inicializa una instancia por defecto. Command containing the data required for the communication; if null, a default instance is created.

NpaCommunicateToSubcontractorCommandRequest
NameDescriptionTypeAdditional information
Id

integer

None.

VersionId

integer

None.

SignedDate

date

None.

Communicate

boolean

None.

RejectReason

string

None.

ReviewReason

string

None.

IsNotAgreed

boolean

None.

IsCommunicate

boolean

None.

IsChecks

boolean

None.

IsRegister

boolean

None.

IsSignedDoc

boolean

None.

Type

ApprovalStepStatusId

None.

RegisterDto

ApprovalFlowExternalRegistrationDto

None.

SignedDocumentCommand

GeneralSignedDocumentCommand

None.

ApprovalFlowSend

ApprovalFlowSendDto

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 2,
  "versionId": 3,
  "signedDate": "2026-07-30T23:03:11.9883055+02:00",
  "communicate": true,
  "rejectReason": "sample string 5",
  "reviewReason": "sample string 6",
  "isNotAgreed": true,
  "isCommunicate": true,
  "isChecks": true,
  "isRegister": true,
  "isSignedDoc": true,
  "type": 1,
  "registerDto": {
    "approvalFlowActionTypeId": 1,
    "approvalFlowEntityId": 1,
    "entityId": 1,
    "entityVersionId": 1,
    "comment": "sample string 2",
    "projectId": 3,
    "subcontractId": 1,
    "registrationUserId": 4,
    "files": [
      {
        "id": 1,
        "name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 2"
      }
    ],
    "approvalDate": "2026-07-30T23:03:11.9883055+02:00",
    "isRequiredDocumentation": true,
    "updateEntityStatus": true,
    "automaticallySendToSap": true,
    "sfrCommunicated": true,
    "fewoCommunicated": true,
    "isCommunicated": true
  },
  "signedDocumentCommand": {
    "id": 1,
    "versionId": 1,
    "documentId": 2
  },
  "approvalFlowSend": {
    "approvalFlowTemplateId": 1,
    "approvalFlowEntityId": 1,
    "entityId": 2,
    "entityVersionId": 1,
    "steps": [
      {
        "stepNumber": 1,
        "execUserId": 2
      },
      {
        "stepNumber": 1,
        "execUserId": 2
      }
    ],
    "projectId": 3,
    "subcontractId": 1
  }
}

text/html

Sample:
{"id":2,"versionId":3,"signedDate":"2026-07-30T23:03:11.9883055+02:00","communicate":true,"rejectReason":"sample string 5","reviewReason":"sample string 6","isNotAgreed":true,"isCommunicate":true,"isChecks":true,"isRegister":true,"isSignedDoc":true,"type":1,"registerDto":{"approvalFlowActionTypeId":1,"approvalFlowEntityId":1,"entityId":1,"entityVersionId":1,"comment":"sample string 2","projectId":3,"subcontractId":1,"registrationUserId":4,"files":[{"id":1,"name":"sample string 2"},{"id":1,"name":"sample string 2"}],"approvalDate":"2026-07-30T23:03:11.9883055+02:00","isRequiredDocumentation":true,"updateEntityStatus":true,"automaticallySendToSap":true,"sfrCommunicated":true,"fewoCommunicated":true,"isCommunicated":true},"signedDocumentCommand":{"id":1,"versionId":1,"documentId":2},"approvalFlowSend":{"approvalFlowTemplateId":1,"approvalFlowEntityId":1,"entityId":2,"entityVersionId":1,"steps":[{"stepNumber":1,"execUserId":2},{"stepNumber":1,"execUserId":2}],"projectId":3,"subcontractId":1}}

application/xml, text/xml

Sample:
<NpaCommunicateToSubcontractorCommandRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos">
  <ApprovalFlowSend xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.ApprovalFlowModule.Application.Dtos.Dtos.ApprovalFlowAgg" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">
    <d2p1:ApprovalFlowEntityId>Subcontract</d2p1:ApprovalFlowEntityId>
    <d2p1:ApprovalFlowTemplateId>1</d2p1:ApprovalFlowTemplateId>
    <d2p1:EntityId>2</d2p1:EntityId>
    <d2p1:EntityVersionId>1</d2p1:EntityVersionId>
    <d2p1:ProjectId>3</d2p1:ProjectId>
    <d2p1:Steps>
      <d2p1:ApprovalFlowSendStepsDto>
        <d2p1:ExecUserId>2</d2p1:ExecUserId>
        <d2p1:StepNumber>1</d2p1:StepNumber>
      </d2p1:ApprovalFlowSendStepsDto>
      <d2p1:ApprovalFlowSendStepsDto>
        <d2p1:ExecUserId>2</d2p1:ExecUserId>
        <d2p1:StepNumber>1</d2p1:StepNumber>
      </d2p1:ApprovalFlowSendStepsDto>
    </d2p1:Steps>
    <d2p1:SubcontractId>1</d2p1:SubcontractId>
  </ApprovalFlowSend>
  <Communicate xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">true</Communicate>
  <Id xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">2</Id>
  <IsChecks xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">true</IsChecks>
  <IsCommunicate xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">true</IsCommunicate>
  <IsNotAgreed xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">true</IsNotAgreed>
  <RegisterDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.ApprovalFlowModule.Application.Dtos.Dtos.ApprovalFlowAgg" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">
    <d2p1:ApprovalDate>2026-07-30T23:03:11.9883055+02:00</d2p1:ApprovalDate>
    <d2p1:ApprovalFlowActionTypeId>Approve</d2p1:ApprovalFlowActionTypeId>
    <d2p1:ApprovalFlowEntityId>Subcontract</d2p1:ApprovalFlowEntityId>
    <d2p1:AutomaticallySendToSap>true</d2p1:AutomaticallySendToSap>
    <d2p1:Comment>sample string 2</d2p1:Comment>
    <d2p1:EntityId>1</d2p1:EntityId>
    <d2p1:EntityVersionId>1</d2p1:EntityVersionId>
    <d2p1:FewoCommunicated>true</d2p1:FewoCommunicated>
    <d2p1:Files xmlns:d3p1="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.Dtos.DocumentAgg">
      <d3p1:DocumentBasicInfoDto>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:DocumentBasicInfoDto>
      <d3p1:DocumentBasicInfoDto>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
      </d3p1:DocumentBasicInfoDto>
    </d2p1:Files>
    <d2p1:IsRequiredDocumentation>true</d2p1:IsRequiredDocumentation>
    <d2p1:ProjectId>3</d2p1:ProjectId>
    <d2p1:RegistrationUserId>4</d2p1:RegistrationUserId>
    <d2p1:SfrCommunicated>true</d2p1:SfrCommunicated>
    <d2p1:SubcontractId>1</d2p1:SubcontractId>
    <d2p1:UpdateEntityStatus>true</d2p1:UpdateEntityStatus>
  </RegisterDto>
  <RejectReason xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">sample string 5</RejectReason>
  <ReviewReason xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">sample string 6</ReviewReason>
  <SignedDate xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">2026-07-30T23:03:11.9883055+02:00</SignedDate>
  <SignedDocumentCommand xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Commands" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">
    <d2p1:DocumentId>2</d2p1:DocumentId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:VersionId>1</d2p1:VersionId>
  </SignedDocumentCommand>
  <Type xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">Pending</Type>
  <VersionId xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.AppServices.NpaAgg.CommandHandlers">3</VersionId>
</NpaCommunicateToSubcontractorCommandRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Resultado HTTP con el resultado de la operación envuelto en un . HTTP result containing the operation result wrapped in an .

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.