Viewings: POST

Create new Viewing.

Request - POST https://api-uat.vtopenview.com/viewings

You will need to supply a request body with this method.
You will need to include your access token upon making a request. For more information, see the authentication and authorization page.

Example request with authorization:

curl -- POST Base URI: https://api-uat.vtopenview.com/viewings --header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Request Body

Example request body:

Content-Type: application/json { "ApplicantId": long, "PropertyId": long, "Lettings": boolean, "Sales": boolean, "Confirmed": boolean, "ViewingStatusId": integer, "Arrangements":"string", "Accompanied": boolean, "ViewingMeetAtId": integer, "KeysHeld": boolean, "KeyNumber": integer, "AccessCode": integer, "RecordType": integer, "PropertyOwnerId": long, "UserId": long, "Feedback": { "PrivateNotes": "string" }, "CalendarEvent": { "Title": "string," "StartDate": "string", "EndDate": "string", "BranchId": long, "CalendarAssignedUsers": [ { "UserId": long } ], "EventCalendars": [ { "CalendarId": integer } ], "ReminderPattern": [ { "FrequencyTypeId": integer } ] } }

Viewing Status Id:

The list below describes the possible Viewing Status ids.

Booked = 1

Feedback Received = 2

Cancelled = 3

On hold = 4

Waiting list = 21

Applicant no show = 30

Example field on request:

"ViewingStatusId": 1

Frequency TypeId Id:

The list below describes the possible Frequency Type ids.

No reminder = 0

1 hour(s) before = 1

2 hour(s) before = 2

3 hour(s) before = 3

5 minute(s) before = 5

10 minute(s) before = 10

15 minute(s) before = 15

30 minute(s) before = 30

Example field on request:

"FrequencyTypeId": 1

Record Type:

The list below describes the possible record type ids.

Property = 3

Example field on request:

"RecordType": 3

Response

If successful, this method returns a response body with the following structure:

Example response:

HTTPS 200 OK Content-Type: Viewing/json { "Viewings": [ { "ViewingsId": long, "CalendarEventId": long, "ApplicantAddressId": long, "Lettings": boolean "Sales": boolean "AllDayEvent": boolean "Title": "string", "AdditionalNotes": "string", "Private": boolean "EventType": "string", "LandlordConfirmed": boolean, "ApplicantConfirmed": boolean, "TenantConfirmed": boolean, "ModifiedDate": "date", "details": { "ApplicantFullName": "string", "viewinfstatusname": "string", "confirmed": boolean "PropertyId": long, "PropertyAddress": "string", "ApplicantId": long, }, "feedback": { "LocationStar": long, "ValueForMoneyStar": long, "AttributesStar": long, "PrivateNotes": "string", "PublicNotes": "string", "StartDate": "date", "EndDate": "date", }, } ] }