latestOpenAPI 3.0.02026-08-12207455917.9 KB

bad0d2db9b7a

Listings

Get create form

Get the dynamic create-listing form for the selected checklist type and office context.

Validation & Requirements

Required Parameters

  • None

Required JSON Body Fields

  • None

Validations

  • Invalid GUID values in *Guid/*Guids fields return 422 Unprocessable Entity.
  • Invalid date values in *date* fields return 422 Unprocessable Entity.
  • Missing required request body returns 422 Unprocessable Entity with Missing request body..
  • Additional business-rule validation may return 422 with details in the errors array.
get/api/files/listingForm

Query parameters

checklistTypeIdinteger

Checklist type ID used to build the form. Get valid values from GET /api/checklistTypes (single-office) or GET /api/offices/{officeGuid}/checklistTypes. Example: 1 for Residential Listing, 2 for Commercial Listing.

officeGuidstring guid nullable

The office you want to add a listing to. If not specified, uses the user's default office. Use GET /api/offices to find office GUIDs

Response

warningsstring[] nullable