POST api/progression/lettings/{id}/addpet

Add Pet. Processes this lettings progression 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 pet data contract supplied with the request.

SetPetDataContract

Name	Description	Type	Additional information
Type	The type value.	string	None.
Breed	The breed value.	string	None.
Status	The status value.	integer	None.
RejectionReason	The rejection reason value.	string	None.
Deposit	The deposit value.	AddTenantDepositDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

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 'SetPetDataContract'.

application/json, text/json

Sample:

{
  "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-09-30T15:44:43.8617529Z",
      "Id": 3
    },
    "HistoricDeposit": true,
    "OperationId": "c6c7f10e-a6d6-4aa8-b0fe-48443e163731",
    "DateReceived": "2026-09-30T15:44:43.8617529Z",
    "DateProtected": "2026-09-30T15:44:43.8617529Z",
    "DepositSchemeId": 4,
    "Id": 5
  },
  "Id": 5
}

Response Information

Resource Description

The response returned after the operation completes.

PermittedPetDataContract

Name	Description	Type	Additional information
Type	The type value.	string	None.
Breed	The breed value.	string	None.
Deposit	The collection of deposit.	Collection of TenantDepositDataContract	None.
Status	The status value.	integer	None.
RejectionReason	The rejection reason value.	string	None.
InvoiceDepositAmount	The invoice deposit amount value.	decimal number	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "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"
        },
        "DepositStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "DepositIdentification": "sample string 3",
        "Id": 4
      },
      "TenantChargeInfo": {
        "Paid": true,
        "AmountPaid": 2.1,
        "DiscountPercentage": 3.1,
        "DueDate": "2026-09-30T15:44:43.8617529Z",
        "PercentageAmount": 4.0,
        "Id": 5
      },
      "OperationId": "4df3cc6c-b39f-4ad2-9427-746c641615c3",
      "DateReceived": "2026-09-30T15:44:43.8617529Z",
      "DateProtected": "2026-09-30T15:44:43.8617529Z",
      "AccountingPostingDate": "2026-09-30T15:44:43.8617529Z",
      "AccountingDepositSchemeId": 1,
      "AccountingInvoiceId": 1,
      "AccountingGeneralLedgerEntryId": 1,
      "Id": 2
    },
    {
      "Name": "sample string 1",
      "Deposit": {
        "PriceValue": 1.1,
        "CurrencyCode": "sample string 2",
        "Scheme": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "DepositStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "DepositIdentification": "sample string 3",
        "Id": 4
      },
      "TenantChargeInfo": {
        "Paid": true,
        "AmountPaid": 2.1,
        "DiscountPercentage": 3.1,
        "DueDate": "2026-09-30T15:44:43.8617529Z",
        "PercentageAmount": 4.0,
        "Id": 5
      },
      "OperationId": "4df3cc6c-b39f-4ad2-9427-746c641615c3",
      "DateReceived": "2026-09-30T15:44:43.8617529Z",
      "DateProtected": "2026-09-30T15:44:43.8617529Z",
      "AccountingPostingDate": "2026-09-30T15:44:43.8617529Z",
      "AccountingDepositSchemeId": 1,
      "AccountingInvoiceId": 1,
      "AccountingGeneralLedgerEntryId": 1,
      "Id": 2
    }
  ],
  "Status": 3,
  "RejectionReason": "sample string 4",
  "InvoiceDepositAmount": 5.1,
  "Id": 6
}