POST api/tenancy/{id}/nextaction

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

SetNextActionDataContract

Name	Type	Additional information
NextAction	EnumDataContract	None.
DateTime	date	None.
Notes	string	None.
NoticeType	EnumDataContract	None.
RenewalAgreement	RenewalAgreementDataContract	None.
TenancyEndingDateOption	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": "2023-02-06T02:38:53.9504893Z",
  "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": "2023-02-06T02:38:53.9504893Z",
      "TenancyType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Term": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "EndDate": "2023-02-06T02:38:53.9504893Z",
      "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",
    "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": "2023-02-06T02:38:53.9504893Z",
          "sample string 3": "2023-02-06T02:38:53.9504893Z"
        },
        "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": "2023-02-06T02:38:53.9504893Z",
          "sample string 3": "2023-02-06T02:38:53.9504893Z"
        },
        "Id": 5
      }
    ],
    "Parking": {
      "ParkingSpaces": 1,
      "ParkingDescription": "sample string 2"
    },
    "Pets": [
      {
        "Type": "sample string 1",
        "Breed": "sample string 2",
        "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": "2023-02-06T02:38:53.9504893Z",
            "Id": 3
          },
          "HistoricDeposit": true,
          "DateProtected": "2023-02-06T02:38:53.9504893Z",
          "DepositSchemeId": 3,
          "Id": 4
        },
        "Id": 3
      },
      {
        "Type": "sample string 1",
        "Breed": "sample string 2",
        "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": "2023-02-06T02:38:53.9504893Z",
            "Id": 3
          },
          "HistoricDeposit": true,
          "DateProtected": "2023-02-06T02:38:53.9504893Z",
          "DepositSchemeId": 3,
          "Id": 4
        },
        "Id": 3
      }
    ],
    "PermittedOccupiers": [
      {
        "DateOfBirth": "2023-02-06T02:38:53.9504893Z",
        "Relationship": "sample string 2",
        "Name": "sample string 3",
        "Id": 4
      },
      {
        "DateOfBirth": "2023-02-06T02:38:53.9504893Z",
        "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

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.