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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

Dezrez.Core.DataContracts.External.Api.Role.Command.Pets.SetPetDataContract
NameDescriptionTypeAdditional information
Type

string

None.

Breed

string

None.

Deposit

Dezrez.Core.DataContracts.External.Api.Role.Command.AddTenantCharge.AddTenantDepositDataContract

None.

Id

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",
  "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": "2024-03-29T12:18:06.7554996Z",
      "Id": 3
    },
    "HistoricDeposit": true,
    "DateProtected": "2024-03-29T12:18:06.7554996Z",
    "DepositSchemeId": 3,
    "Id": 4
  },
  "Id": 3
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.PermittedPetDataContract
NameDescriptionTypeAdditional information
Type

string

None.

Breed

string

None.

Deposit

Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.Charges.TenantDepositDataContract

None.

InvoiceDepositAmount

decimal number

None.

Id

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": "2024-03-29T12:18:06.7554996Z",
        "PercentageAmount": 4.0,
        "Id": 5
      },
      "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": "2024-03-29T12:18:06.7554996Z",
        "PercentageAmount": 4.0,
        "Id": 5
      },
      "Id": 2
    }
  ],
  "InvoiceDepositAmount": 3.1,
  "Id": 4
}