POST api/progression/sales/instructtosell
Instructs a role to be sold
Request Information
URI Parameters
None.
Body Parameters
Details of the instruction
Dezrez.Core.DataContracts.External.Api.Events.Progression.Command.InstructToSellCommandDataContractName | Description | Type | Additional information |
---|---|---|---|
RoleId | integer |
None. |
|
ActualMarketingPrice | decimal number |
None. |
|
TeamId | integer |
None. |
|
PutOnMarket | boolean |
None. |
|
InstructedDateTime | date |
None. |
|
NegotiatorIds | Collection of integer |
None. |
|
LeaseType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
ValidEpcInPlace | boolean |
None. |
|
ProofOfIdReceived | boolean |
None. |
|
ProofOfOwnershipReceived | boolean |
None. |
|
BranchId | integer |
None. |
|
ExternalCompanyInstructorId | integer |
None. |
|
AgencyPeriod | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
PriceText | string |
None. |
|
PriceOnApplication | boolean |
None. |
|
PriceQualifier | 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, "TeamId": 3, "PutOnMarket": true, "InstructedDateTime": "2024-10-11T17:49:18.8621972Z", "NegotiatorIds": [ 1, 2 ], "LeaseType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ValidEpcInPlace": true, "ProofOfIdReceived": true, "ProofOfOwnershipReceived": true, "BranchId": 1, "ExternalCompanyInstructorId": 1, "AgencyPeriod": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "PriceText": "sample string 5", "PriceOnApplication": true, "PriceQualifier": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SendToPortal": true }
Response Information
Resource Description
Dezrez.Core.DataContracts.External.Api.Events.Progression.Query.InstructionToSellDataContractResponse Formats
application/json, text/json
Sample:
{ "ExternalCompanyInstructorId": 1, "Team": { "Name": "sample string 1", "CreatedDate": "2024-10-11T17:49:18.8621972Z", "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-11T17:49:18.8621972Z", "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-11T17:49:18.8621972Z", "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-11T17:49:18.8621972Z", "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-11T17:49:18.8621972Z", "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-11T17:49:18.8621972Z", "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-11T17:49:18.8621972Z", "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 2", "Description": "sample string 3", "DateTime": "2024-10-11T17:49:18.8621972Z", "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": 5, "OwningTeamId": 6, "TeamAccessType": "sample string 7", "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-11T17:49:18.8621972Z", "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 }