POST api/progression/lettings/instructtolet
Instructs a role to be let
Request Information
URI Parameters
None.
Body Parameters
Details of the instruction
Dezrez.Core.DataContracts.External.Api.Events.Progression.Command.InstructToLetCommandDataContractName | Description | Type | Additional information |
---|---|---|---|
RoleId | integer |
None. |
|
ActualMarketingPrice | decimal number |
None. |
|
OccupierAllowanceDescription | Dezrez.Core.DataContracts.External.Api.Descriptions.Command.OccupierAllowanceDescriptionSaveDataContract |
None. |
|
DepositPriceValue | decimal number |
None. |
|
DepositScheme | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
TeamId | integer |
None. |
|
PutOnMarket | boolean |
None. |
|
TermsReceived | boolean |
None. |
|
InstructedDateTime | date |
None. |
|
NegotiatorIds | Collection of integer |
None. |
|
LeaseType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
AvailableDate | date |
None. |
|
ValidEpcInPlace | boolean |
None. |
|
ProofOfIdReceived | boolean |
None. |
|
ProofOfOwnershipReceived | boolean |
None. |
|
AgencyPeriod | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
BranchId | integer |
None. |
|
FurnishingLevel | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
SendToPortal | boolean |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{ "RoleId": 1, "ActualMarketingPrice": 2.1, "OccupierAllowanceDescription": { "Pairs": [ { "Key": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 1 }, { "Key": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 1 } ], "Name": "sample string 1", "Notes": "sample string 2", "PropertyId": 3, "RoleId": 4, "ForceUpdate": true, "Id": 6 }, "DepositPriceValue": 3.1, "DepositScheme": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "TeamId": 4, "PutOnMarket": true, "TermsReceived": true, "InstructedDateTime": "2024-10-15T17:46:48.4436472Z", "NegotiatorIds": [ 1, 2 ], "LeaseType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "AvailableDate": "2024-10-15T17:46:48.4436472Z", "ValidEpcInPlace": true, "ProofOfIdReceived": true, "ProofOfOwnershipReceived": true, "AgencyPeriod": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "BranchId": 1, "FurnishingLevel": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SendToPortal": true }
Response Information
Resource Description
Dezrez.Core.DataContracts.External.Api.Events.Progression.Query.InstructionToLetDataContractResponse Formats
application/json, text/json
Sample:
{ "Team": { "Name": "sample string 1", "CreatedDate": "2024-10-15T17:46:48.4592696Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 3 }, "Notes": [ { "Note": "sample string 1", "DateAdded": "2024-10-15T17:46:48.4592696Z", "NegotiatorId": 1, "NegotiatorEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "NegotiatorName": "sample string 2", "Id": 3 }, { "Note": "sample string 1", "DateAdded": "2024-10-15T17:46:48.4592696Z", "NegotiatorId": 1, "NegotiatorEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "NegotiatorName": "sample string 2", "Id": 3 } ], "Documents": [ { "Url": "sample string 1", "RequiresAuthentication": true, "ExpiryDate": "2024-10-15T17:46:48.4592696Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 3", "ContentType": "sample string 4", "FileExtension": "sample string 5", "Description": "sample string 6", "FileSize": "sample string 7", "CreatedDate": "2024-10-15T17:46:48.4592696Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 9 }, { "Url": "sample string 1", "RequiresAuthentication": true, "ExpiryDate": "2024-10-15T17:46:48.4592696Z", "FileStream": null, "Tags": [ { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 }, { "Name": "sample string 1", "SystemStatusName": "sample string 2", "TagType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 3 } ], "DocumentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "DocumentSubType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FileName": "sample string 3", "ContentType": "sample string 4", "FileExtension": "sample string 5", "Description": "sample string 6", "FileSize": "sample string 7", "CreatedDate": "2024-10-15T17:46:48.4592696Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 9 } ], "Name": "sample string 1", "Description": "sample string 2", "DateTime": "2024-10-15T17:46:48.4592696Z", "EventCategory": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "EventType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "EventStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Negotiators": [ { "ContactName": "sample string 1", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 5", "Id": 6 }, { "ContactName": "sample string 1", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 5", "Id": 6 } ], "BranchId": 4, "OwningTeamId": 5, "TeamAccessType": "sample string 6", "CustomFields": [ { "Name": "sample string 1", "Values": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} } ] }, { "Name": "sample string 1", "Values": [ { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} }, { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 1", "Value": {} } ] } ], "CreatedDate": "2024-10-15T17:46:48.4592696Z", "CreatedBy": { "Initials": "sample string 1", "ContactName": "sample string 2", "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 3", "FirstName": "sample string 4", "LastName": "sample string 5", "PrimaryTelephone": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "PrimaryEmail": { "Type": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Value": "sample string 1", "Notes": "sample string 2", "ContactOrder": 3, "AllowContact": true, "MarketingContactStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Name": "sample string 5", "Id": 6 }, "JobTitle": "sample string 6", "Id": 7 }, "Id": 8 }