POST api/documentgeneration/tenancyagreementast

Request Information

URI Parameters

None.

Body Parameters

TenancyPackDataContract
NameDescriptionTypeAdditional information
TenancyRoleId

integer

None.

TenancyAgreementId

integer

None.

SackFriendlyName

string

None.

EnvelopeTemplatePackId

integer

None.

BrandId

integer

None.

BranchId

integer

None.

NegotiatorPpId

integer

None.

CustomText

string

None.

EnvelopeProcessingMethod

EnumDataContract

None.

AutoProcessSack

boolean

None.

SendToDrafts

boolean

None.

PrintedOnHeaded

boolean

None.

WorkflowIndex

integer

None.

DestinationPrintBagName

string

None.

PostDocGenerationHandler

PostDocGenerationHandlerDataContract

None.

PreviewOnly

boolean

None.

EmailSubject

string

None.

Id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "TenancyRoleId": 1,
  "TenancyAgreementId": 2,
  "SackFriendlyName": "sample string 3",
  "EnvelopeTemplatePackId": 4,
  "BrandId": 5,
  "BranchId": 1,
  "NegotiatorPpId": 6,
  "CustomText": "sample string 7",
  "EnvelopeProcessingMethod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AutoProcessSack": true,
  "SendToDrafts": true,
  "PrintedOnHeaded": true,
  "WorkflowIndex": 11,
  "DestinationPrintBagName": "sample string 12",
  "PostDocGenerationHandler": {
    "EntityType": "sample string 1",
    "EntityId": 2,
    "JobHandlerType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Options": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "DocumentSubType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  },
  "PreviewOnly": true,
  "EmailSubject": "sample string 14",
  "Id": 15
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TenancyPackDataContract'.

Response Information

Resource Description

JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

boolean

None.

ReportsProgress

boolean

None.

InitialStatusText

string

None.

JobReference

globally unique identifier

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "4bc77db6-e919-4f0c-8aed-5eeae4c8622c",
  "Success": true
}