POST api/viewing/bookviewing

Book a Viewing.

Request Information

URI Parameters

None.

Body Parameters

the viewing detail

SaveAppointmentCommandDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Description

string

None.

PropertyId

integer

None.

RoleId

integer

None.

AppointmentDetail

AppointmentDetailCommandDataContract

None.

EventType

string

None.

ReasonOfCancellation

string

None.

OriginalDate

date

None.

ExternalAppointmentReference

string

None.

EditingRecurringOption

integer

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "PropertyId": 3,
  "RoleId": 4,
  "AppointmentDetail": {
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AllDayEvent": true,
    "StartDate": "2025-07-05T19:55:20.2468698Z",
    "EndDate": "2025-07-05T19:55:20.2468698Z",
    "EventStatus": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "MeetingPlaceId": 5,
    "TeamId": 6,
    "EventCategory": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "EventType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "NegotiatorIds": [
      1,
      2
    ],
    "AttendingGroups": [
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Group": {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Members": [
            {
              "Person": {
                "PersonId": 1,
                "Gender": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Title": "sample string 1",
                "FirstName": "sample string 2",
                "LastName": "sample string 3",
                "Addresses": [
                  {
                    "ContactOrder": 1,
                    "AddressType": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Latitude": 2.1,
                    "Longitude": 3.1,
                    "AddressSource": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "SourceId": "sample string 4",
                    "OrganizationName": "sample string 5",
                    "Number": "sample string 6",
                    "BuildingName": "sample string 7",
                    "Street": "sample string 8",
                    "Town": "sample string 9",
                    "Locality": "sample string 10",
                    "County": "sample string 11",
                    "Postcode": "sample string 12",
                    "CreatedDate": "2025-07-05T19:55:20.2468698Z",
                    "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": 14
                  },
                  {
                    "ContactOrder": 1,
                    "AddressType": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Latitude": 2.1,
                    "Longitude": 3.1,
                    "AddressSource": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "SourceId": "sample string 4",
                    "OrganizationName": "sample string 5",
                    "Number": "sample string 6",
                    "BuildingName": "sample string 7",
                    "Street": "sample string 8",
                    "Town": "sample string 9",
                    "Locality": "sample string 10",
                    "County": "sample string 11",
                    "Postcode": "sample string 12",
                    "CreatedDate": "2025-07-05T19:55:20.2468698Z",
                    "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": 14
                  }
                ],
                "ContactItems": [
                  {
                    "Id": 1,
                    "Type": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Value": "sample string 2",
                    "Notes": "sample string 3",
                    "ContactOrder": 4,
                    "AllowContact": true,
                    "MarketingContactStatus": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "NormalisedRegionCode": "sample string 5"
                  },
                  {
                    "Id": 1,
                    "Type": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Value": "sample string 2",
                    "Notes": "sample string 3",
                    "ContactOrder": 4,
                    "AllowContact": true,
                    "MarketingContactStatus": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "NormalisedRegionCode": "sample string 5"
                  }
                ],
                "ServiceTypes": [
                  {
                    "Service": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Referral": true
                  },
                  {
                    "Service": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Referral": true
                  }
                ],
                "ExternalApplicantReference": "sample string 4",
                "Id": 5
              },
              "RelationshipType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 1
            },
            {
              "Person": {
                "PersonId": 1,
                "Gender": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Title": "sample string 1",
                "FirstName": "sample string 2",
                "LastName": "sample string 3",
                "Addresses": [
                  {
                    "ContactOrder": 1,
                    "AddressType": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Latitude": 2.1,
                    "Longitude": 3.1,
                    "AddressSource": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "SourceId": "sample string 4",
                    "OrganizationName": "sample string 5",
                    "Number": "sample string 6",
                    "BuildingName": "sample string 7",
                    "Street": "sample string 8",
                    "Town": "sample string 9",
                    "Locality": "sample string 10",
                    "County": "sample string 11",
                    "Postcode": "sample string 12",
                    "CreatedDate": "2025-07-05T19:55:20.2468698Z",
                    "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": 14
                  },
                  {
                    "ContactOrder": 1,
                    "AddressType": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Latitude": 2.1,
                    "Longitude": 3.1,
                    "AddressSource": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "SourceId": "sample string 4",
                    "OrganizationName": "sample string 5",
                    "Number": "sample string 6",
                    "BuildingName": "sample string 7",
                    "Street": "sample string 8",
                    "Town": "sample string 9",
                    "Locality": "sample string 10",
                    "County": "sample string 11",
                    "Postcode": "sample string 12",
                    "CreatedDate": "2025-07-05T19:55:20.2468698Z",
                    "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": 14
                  }
                ],
                "ContactItems": [
                  {
                    "Id": 1,
                    "Type": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Value": "sample string 2",
                    "Notes": "sample string 3",
                    "ContactOrder": 4,
                    "AllowContact": true,
                    "MarketingContactStatus": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "NormalisedRegionCode": "sample string 5"
                  },
                  {
                    "Id": 1,
                    "Type": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Value": "sample string 2",
                    "Notes": "sample string 3",
                    "ContactOrder": 4,
                    "AllowContact": true,
                    "MarketingContactStatus": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "NormalisedRegionCode": "sample string 5"
                  }
                ],
                "ServiceTypes": [
                  {
                    "Service": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Referral": true
                  },
                  {
                    "Service": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Referral": true
                  }
                ],
                "ExternalApplicantReference": "sample string 4",
                "Id": 5
              },
              "RelationshipType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 1
            }
          ],
          "GroupType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Origin": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Grade": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ExternalProviderTypes": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "VATNumber": "sample string 3",
          "AdditionalQuestions": {
            "ArrangedMortgage": true,
            "MortgageProvider": "sample string 1",
            "HowLongToMove": "sample string 2",
            "ReasonForMoving": "sample string 3",
            "HowHeard": "sample string 4",
            "EnquiryMethod": "sample string 5",
            "BestTimeToCall": "sample string 6",
            "WhenCanView": "sample string 7",
            "HappyToReceivePropertyEmails": true,
            "ViewedAnyProperties": true,
            "LocalOwnToSell": true,
            "AskingPrice": "sample string 8",
            "Bedrooms": 1,
            "CurrentlyOnMarket": true,
            "SellingWith": "sample string 9",
            "OnMarketSince": "2025-07-05T19:55:20.2468698Z",
            "ReasonForSale": "sample string 10",
            "OfferedMA": true,
            "CurrentStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Financial": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Reason": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          },
          "BranchId": 1,
          "Id": 4
        },
        "AttendingPeopleIds": [
          1,
          2
        ]
      },
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Group": {
          "Name": "sample string 1",
          "Description": "sample string 2",
          "Members": [
            {
              "Person": {
                "PersonId": 1,
                "Gender": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Title": "sample string 1",
                "FirstName": "sample string 2",
                "LastName": "sample string 3",
                "Addresses": [
                  {
                    "ContactOrder": 1,
                    "AddressType": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Latitude": 2.1,
                    "Longitude": 3.1,
                    "AddressSource": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "SourceId": "sample string 4",
                    "OrganizationName": "sample string 5",
                    "Number": "sample string 6",
                    "BuildingName": "sample string 7",
                    "Street": "sample string 8",
                    "Town": "sample string 9",
                    "Locality": "sample string 10",
                    "County": "sample string 11",
                    "Postcode": "sample string 12",
                    "CreatedDate": "2025-07-05T19:55:20.2468698Z",
                    "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": 14
                  },
                  {
                    "ContactOrder": 1,
                    "AddressType": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Latitude": 2.1,
                    "Longitude": 3.1,
                    "AddressSource": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "SourceId": "sample string 4",
                    "OrganizationName": "sample string 5",
                    "Number": "sample string 6",
                    "BuildingName": "sample string 7",
                    "Street": "sample string 8",
                    "Town": "sample string 9",
                    "Locality": "sample string 10",
                    "County": "sample string 11",
                    "Postcode": "sample string 12",
                    "CreatedDate": "2025-07-05T19:55:20.2468698Z",
                    "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": 14
                  }
                ],
                "ContactItems": [
                  {
                    "Id": 1,
                    "Type": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Value": "sample string 2",
                    "Notes": "sample string 3",
                    "ContactOrder": 4,
                    "AllowContact": true,
                    "MarketingContactStatus": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "NormalisedRegionCode": "sample string 5"
                  },
                  {
                    "Id": 1,
                    "Type": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Value": "sample string 2",
                    "Notes": "sample string 3",
                    "ContactOrder": 4,
                    "AllowContact": true,
                    "MarketingContactStatus": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "NormalisedRegionCode": "sample string 5"
                  }
                ],
                "ServiceTypes": [
                  {
                    "Service": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Referral": true
                  },
                  {
                    "Service": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Referral": true
                  }
                ],
                "ExternalApplicantReference": "sample string 4",
                "Id": 5
              },
              "RelationshipType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 1
            },
            {
              "Person": {
                "PersonId": 1,
                "Gender": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Title": "sample string 1",
                "FirstName": "sample string 2",
                "LastName": "sample string 3",
                "Addresses": [
                  {
                    "ContactOrder": 1,
                    "AddressType": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Latitude": 2.1,
                    "Longitude": 3.1,
                    "AddressSource": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "SourceId": "sample string 4",
                    "OrganizationName": "sample string 5",
                    "Number": "sample string 6",
                    "BuildingName": "sample string 7",
                    "Street": "sample string 8",
                    "Town": "sample string 9",
                    "Locality": "sample string 10",
                    "County": "sample string 11",
                    "Postcode": "sample string 12",
                    "CreatedDate": "2025-07-05T19:55:20.2468698Z",
                    "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": 14
                  },
                  {
                    "ContactOrder": 1,
                    "AddressType": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Latitude": 2.1,
                    "Longitude": 3.1,
                    "AddressSource": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "SourceId": "sample string 4",
                    "OrganizationName": "sample string 5",
                    "Number": "sample string 6",
                    "BuildingName": "sample string 7",
                    "Street": "sample string 8",
                    "Town": "sample string 9",
                    "Locality": "sample string 10",
                    "County": "sample string 11",
                    "Postcode": "sample string 12",
                    "CreatedDate": "2025-07-05T19:55:20.2468698Z",
                    "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": 14
                  }
                ],
                "ContactItems": [
                  {
                    "Id": 1,
                    "Type": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Value": "sample string 2",
                    "Notes": "sample string 3",
                    "ContactOrder": 4,
                    "AllowContact": true,
                    "MarketingContactStatus": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "NormalisedRegionCode": "sample string 5"
                  },
                  {
                    "Id": 1,
                    "Type": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Value": "sample string 2",
                    "Notes": "sample string 3",
                    "ContactOrder": 4,
                    "AllowContact": true,
                    "MarketingContactStatus": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "NormalisedRegionCode": "sample string 5"
                  }
                ],
                "ServiceTypes": [
                  {
                    "Service": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Referral": true
                  },
                  {
                    "Service": {
                      "Id": 1,
                      "Name": "sample string 2",
                      "SystemName": "sample string 3"
                    },
                    "Referral": true
                  }
                ],
                "ExternalApplicantReference": "sample string 4",
                "Id": 5
              },
              "RelationshipType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 1
            }
          ],
          "GroupType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Origin": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Grade": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ExternalProviderTypes": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "VATNumber": "sample string 3",
          "AdditionalQuestions": {
            "ArrangedMortgage": true,
            "MortgageProvider": "sample string 1",
            "HowLongToMove": "sample string 2",
            "ReasonForMoving": "sample string 3",
            "HowHeard": "sample string 4",
            "EnquiryMethod": "sample string 5",
            "BestTimeToCall": "sample string 6",
            "WhenCanView": "sample string 7",
            "HappyToReceivePropertyEmails": true,
            "ViewedAnyProperties": true,
            "LocalOwnToSell": true,
            "AskingPrice": "sample string 8",
            "Bedrooms": 1,
            "CurrentlyOnMarket": true,
            "SellingWith": "sample string 9",
            "OnMarketSince": "2025-07-05T19:55:20.2468698Z",
            "ReasonForSale": "sample string 10",
            "OfferedMA": true,
            "CurrentStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Financial": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Reason": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          },
          "BranchId": 1,
          "Id": 4
        },
        "AttendingPeopleIds": [
          1,
          2
        ]
      }
    ],
    "SpecialArrangements": [
      {
        "Text": "sample string 1",
        "SpecialArrangementType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ApplicableToGroupIds": [
          1,
          2
        ],
        "Id": 2
      },
      {
        "Text": "sample string 1",
        "SpecialArrangementType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ApplicableToGroupIds": [
          1,
          2
        ],
        "Id": 2
      }
    ],
    "FollowUpNegotiatorId": 7,
    "AppointmentRecurringSchedule": {
      "Id": 1,
      "Frequency": 0,
      "Occurrences": 2,
      "Interval": 3,
      "DaysOfTheWeek": [
        1,
        2
      ],
      "RecurringStartDate": "2025-07-05T19:55:20.2624917Z",
      "RecurringEndDate": "2025-07-05T19:55:20.2624917Z"
    },
    "ExternalAppointmentReference": "sample string 8",
    "Id": 9
  },
  "EventType": "sample string 5",
  "ReasonOfCancellation": "sample string 6",
  "OriginalDate": "2025-07-05T19:55:20.2624917Z",
  "ExternalAppointmentReference": "sample string 7",
  "EditingRecurringOption": 8,
  "Id": 9
}

Response Information

Resource Description

BookViewingResponseDataContract
NameDescriptionTypeAdditional information
RoleId

integer

None.

GroupIds

Collection of integer

None.

ViewingAppointmentId

integer

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "RoleId": 1,
  "GroupIds": [
    1,
    2
  ],
  "ViewingAppointmentId": 2,
  "IsSuccess": true
}