POST api/tenancy/{id}/nextaction

Next Action. Processes this tenancy API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the requested resource.	integer	Required

Body Parameters

The set next action data contract supplied with the request.

SetNextActionDataContract

Name	Description	Type	Additional information
NextAction	The next action value.	EnumDataContract	None.
DateTime	The date time, expressed as a date and time.	date	None.
Notes	The notes value.	string	None.
NoticeType	The notice type value.	EnumDataContract	None.
RenewalAgreement	The renewal agreement value.	RenewalAgreementDataContract	None.
TenancyEndingDateOption	The tenancy ending date option value.	EnumDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "NextAction": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DateTime": "2026-07-24T10:07:17.2018343Z",
  "Notes": "sample string 1",
  "NoticeType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RenewalAgreement": {
    "ModifyCurrentAgreement": true,
    "ExistingAgreement": {
      "NoticePeriod": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "StartDate": "2026-07-24T10:07:17.2018343Z",
      "TenancyType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Term": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "EndDate": "2026-07-24T10:07:17.2018343Z",
      "RentAmount": 1.0,
      "PriceType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    },
    "Agreement": {
      "AgreementType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      }
    },
    "DepositAmount": {
      "PriceValue": 1.1,
      "CurrencyCode": "sample string 2",
      "Scheme": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Status": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "DepositIdentification": "sample string 3",
      "Id": 4
    },
    "BreakClause": "sample string 2",
    "SpecialClause": "sample string 3",
    "FurnishLevel": {
      "FurnishLevel": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 1
    },
    "AdditionalServices": [
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ProviderGroupId": 1,
        "PropertyServiceType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "IsPaidByOwner": true,
        "Notified": true,
        "AdditionalServiceType": 0,
        "Readings": {
          "sample string 1": "2026-07-24T10:07:17.2018343Z",
          "sample string 3": "2026-07-24T10:07:17.2018343Z"
        },
        "Id": 5
      },
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ProviderGroupId": 1,
        "PropertyServiceType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "IsPaidByOwner": true,
        "Notified": true,
        "AdditionalServiceType": 0,
        "Readings": {
          "sample string 1": "2026-07-24T10:07:17.2018343Z",
          "sample string 3": "2026-07-24T10:07:17.2018343Z"
        },
        "Id": 5
      }
    ],
    "Parking": {
      "ParkingSpaces": 1,
      "ParkingDescription": "sample string 2"
    },
    "Pets": [
      {
        "Type": "sample string 1",
        "Breed": "sample string 2",
        "Status": 3,
        "RejectionReason": "sample string 4",
        "Deposit": {
          "Name": "sample string 1",
          "Deposit": {
            "PriceValue": 1.1,
            "CurrencyCode": "sample string 2",
            "Scheme": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Status": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "DepositIdentification": "sample string 3",
            "Id": 4
          },
          "TenantChargeInfo": {
            "AmountPaid": 1.1,
            "DiscountPercentage": 2.1,
            "DueDate": "2026-07-24T10:07:17.2018343Z",
            "Id": 3
          },
          "HistoricDeposit": true,
          "DateProtected": "2026-07-24T10:07:17.2018343Z",
          "DepositSchemeId": 3,
          "Id": 4
        },
        "Id": 5
      },
      {
        "Type": "sample string 1",
        "Breed": "sample string 2",
        "Status": 3,
        "RejectionReason": "sample string 4",
        "Deposit": {
          "Name": "sample string 1",
          "Deposit": {
            "PriceValue": 1.1,
            "CurrencyCode": "sample string 2",
            "Scheme": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Status": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "DepositIdentification": "sample string 3",
            "Id": 4
          },
          "TenantChargeInfo": {
            "AmountPaid": 1.1,
            "DiscountPercentage": 2.1,
            "DueDate": "2026-07-24T10:07:17.2018343Z",
            "Id": 3
          },
          "HistoricDeposit": true,
          "DateProtected": "2026-07-24T10:07:17.2018343Z",
          "DepositSchemeId": 3,
          "Id": 4
        },
        "Id": 5
      }
    ],
    "PermittedOccupiers": [
      {
        "DateOfBirth": "2026-07-24T10:07:17.2018343Z",
        "Relationship": "sample string 2",
        "Name": "sample string 3",
        "Id": 4
      },
      {
        "DateOfBirth": "2026-07-24T10:07:17.2018343Z",
        "Relationship": "sample string 2",
        "Name": "sample string 3",
        "Id": 4
      }
    ],
    "TenantRequirement": {
      "IsSmoker": true,
      "IsStudent": true,
      "HasChildren": true,
      "HasPets": true,
      "ReceivesHousingBenefits": true,
      "Id": 1
    }
  },
  "TenancyEndingDateOption": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  }
}

Response Information

Resource Description

The response returned after the operation completes.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.