### GET /intg/products Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Searches for available products with optional filtering by title, offset, and limit. ```APIDOC ## GET /intg/products ### Description Searches for available products. You can filter the results by title and specify offset and limit for pagination. ### Method GET ### Endpoint /intg/products ### Parameters #### Query Parameters - **Title** (string) - Optional - Filters products by title. - **Offset** (integer) - Optional - The number of items to skip. - **Limit** (integer) - Optional - The maximum number of items to return. - **api-version** (string) - Optional - Specifies the API version. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **schema** (object) - Reference to `ProductSearchResponse` schema. #### Response Example (Response structure depends on `ProductSearchResponse` schema) ``` -------------------------------- ### GET /intg/users/roles Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves a list of available roles for users within the system. ```APIDOC ## GET /intg/users/roles ### Description Shows the available roles. ### Method GET ### Endpoint /intg/users/roles ### Parameters #### Query Parameters - **api-version** (string) - Optional - The version of the API to use. ### Response #### Success Response (200) - **schema** (RolesResponse) - The response schema containing the available roles. #### Response Example ```json { "roles": [ "string" ] } ``` #### Error Response (500) - **description** (string) - Server Error details. ``` -------------------------------- ### GET /intg/callbacks Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves a list of registered callbacks for the current organization. ```APIDOC ## GET /intg/callbacks ### Description Retrieves a list of callbacks that have been registered for the current organization. ### Method GET ### Endpoint /intg/callbacks ### Parameters #### Query Parameters - **api-version** (string) - Optional - Specifies the API version. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **schema** (object) - Reference to `SearchRegisteredCallbackResponse` schema. #### Response Example (Response structure depends on `SearchRegisteredCallbackResponse` schema) ``` -------------------------------- ### Get Registered Callbacks Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves a list of registered callbacks for the current organization. Requires the API version. Returns a search response for registered callbacks or an error. ```openapi { "get": { "tags": [ "RegisteredCallbacks" ], "summary": "Get Registered callbacks for the current organization", "parameters": [ { "name": "api-version", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRegisteredCallbackResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModelBase" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "ClassValuation": [] } ] } } ``` -------------------------------- ### GET /intg/users Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Searches for available users based on provided query parameters such as UserName, Email, Offset, and Limit. Returns a collection of user information or an error. ```APIDOC ## GET /intg/users ### Description Searches for available users. ### Method GET ### Endpoint /intg/users ### Parameters #### Query Parameters - **UserName** (string) - Optional - Filter users by username. - **Email** (string) - Optional - Filter users by email. - **Offset** (integer) - Optional - The number of records to skip. - **Limit** (integer) - Optional - The maximum number of records to return. - **api-version** (string) - Optional - API version parameter. ### Response #### Success Response (200) - **UserCollectionResponse** (object) - A collection of user information. #### Error Response - **500**: Server Error. Returns an ErrorModelBase schema. - **401**: Unauthorized. - **403**: Forbidden. ``` -------------------------------- ### Get User Roles API Operation Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders This GET endpoint retrieves the available roles for users. It requires an 'api-version' query parameter. The successful response contains a 'RolesResponse' schema, while a server error returns an 'ErrorModelBase' schema. ```json { "/intg/users/roles": { "get": { "tags": [ "Users" ], "summary": "Shows the available roles", "parameters": [ { "name": "api-version", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { ``` -------------------------------- ### Create User Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Creates a new user account with provided details. Requires email and username. ```APIDOC ## POST /users ### Description Creates a new user account with provided details. Requires email and username. ### Method POST ### Endpoint /users ### Parameters #### Request Body - **userName** (string) - Required - The username for the new account. - **email** (string) - Required - The email address for the new account. - **firstName** (string) - Optional - The first name of the user. - **lastName** (string) - Optional - The last name of the user. - **phone** (string) - Optional - The phone number of the user. - **address** (string) - Optional - The address of the user. - **city** (string) - Optional - The city of the user. - **state** (string) - Optional - The state of the user. - **zipCode** (string) - Optional - The zip code of the user. ### Request Example ```json { "userName": "johndoe", "email": "john.doe@example.com", "firstName": "John", "lastName": "Doe", "phone": "123-456-7890", "address": "123 Main St", "city": "Anytown", "state": "CA", "zipCode": "90210" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **userId** (string) - The ID of the created user (nullable). #### Response Example ```json { "success": true, "userId": "user_xyz789" } ``` #### Error Response (400) - **success** (boolean) - Always false. - **error** (string) - A message describing the error. #### Error Response Example ```json { "success": false, "error": "Email address already in use." } ``` ``` -------------------------------- ### GET /intg/avm/status Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves the status of an AVM order by its ID. ```APIDOC ## GET /intg/avm/status ### Description Retrieves the status of an AVM order using the provided order ID. ### Method GET ### Endpoint /intg/avm/status ### Parameters #### Query Parameters - **orderId** (integer) - Optional - The ID of the AVM order to retrieve the status for. - **api-version** (string) - Optional - Specifies the API version. ### Request Example ```json { "example": "Not applicable for GET request without a body" } ``` ### Response #### Success Response (200) - **string** - The status of the AVM order. #### Response Example ```json { "example": "Processing" } ``` ``` -------------------------------- ### Search Available Products Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves a list of available products based on provided query parameters. Supports filtering by title, offset, and limit. Requires API version. Returns a product search response or an error. ```openapi { "get": { "tags": [ "Products" ], "summary": "Search availables products", "parameters": [ { "name": "Title", "in": "query", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "api-version", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModelBase" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "ClassValuation": [] } ] } } ``` -------------------------------- ### Get GSE Submission Info Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves information about GSE submissions. ```APIDOC ## GET /gse/submissions ### Description Retrieves information about GSE submissions. ### Method GET ### Endpoint /gse/submissions ### Query Parameters - **gseName** (string) - Optional - Filters submissions by GSE name. - **gseId** (string) - Optional - Filters submissions by GSE ID. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **message** (string) - An optional message providing details about the response. - **data** (array) - An array of GSE submission data objects. - **gseName** (string) - The name of the GSE. - **gseId** (string) - The identifier for the GSE submission. - **resultMessage** (string) - A message associated with the GSE submission result. - **validations** (array) - An array of validation objects. - **completeness** (array) - An array of completeness objects. #### Response Example ```json { "success": true, "message": null, "data": [ { "gseName": "FNMA", "gseId": "fannie-123", "resultMessage": "Submission processed successfully.", "validations": [ { "name": "PropertyTypeValidation", "code": "P1001", "description": "Property type is valid." } ], "completeness": [ { "code": "C2001", "description": "All required fields are present." } ] } ] } ``` ``` -------------------------------- ### Product Search API Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Searches for products based on various criteria. Returns a list of matching products. ```APIDOC ## GET /products ### Description Searches for products based on various criteria. Returns a list of matching products. ### Method GET ### Endpoint /products ### Query Parameters - **ProductName** (string) - Optional - Filters products by name. - **PaymentMethod** (string) - Optional - Filters products by payment method. ### Request Example ```json { "ProductName": "ProcisionPremier", "PaymentMethod": "Invoice" } ``` ### Response #### Success Response (200) - **products** (array) - A list of ProductResponse objects. - **success** (boolean) - Indicates if the request was successful. - **message** (string) - A message providing details about the response. #### Response Example ```json { "products": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "title": "Procision Premier", "active": true, "isLicensingEnabled": false, "created": "2023-10-27T10:00:00Z" } ], "success": true, "message": "Products retrieved successfully." } ``` ``` -------------------------------- ### POST /intg/users Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Creates a new user by accepting user details in the request body. It supports various JSON content types and returns success or error information. ```APIDOC ## POST /intg/users ### Description Creates a new user. ### Method POST ### Endpoint /intg/users ### Parameters #### Query Parameters - **api-version** (string) - Optional - API version parameter. #### Request Body - **CreateUserRequest** (object) - Required - The schema for creating a user. ### Request Example ```json { "example": "CreateUserRequest object" } ``` ### Response #### Success Response (200) - **CreateUserResponse** (object) - Details of the created user. #### Error Response - **500**: Server Error. Returns an ErrorModelBase schema. - **401**: Unauthorized. - **403**: Forbidden. ``` -------------------------------- ### Get Related Organizations Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves a list of organizations related to a specific organization. ```APIDOC ## GET /organizations/related ### Description Retrieves a list of related organizations. ### Method GET ### Endpoint /organizations/related ### Query Parameters - **organizationId** (string) - Required - The ID of the organization for which to retrieve related organizations. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **message** (string) - An optional message providing details about the response. - **data** (array) - An array of basic organization information objects. - **organizationId** (string) - The ID of the related organization. - **name** (string) - The name of the related organization. #### Response Example ```json { "success": true, "message": null, "data": [ { "organizationId": "org-67890", "name": "Related Org A" }, { "organizationId": "org-11223", "name": "Related Org B" } ] } ``` ``` -------------------------------- ### Get Parent Organizations Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves the parent organization ID for a given organization. ```APIDOC ## GET /organizations/parent ### Description Retrieves the parent organization ID. ### Method GET ### Endpoint /organizations/parent ### Query Parameters - **organizationId** (string) - Required - The ID of the organization. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **message** (string) - An optional message providing details about the response. - **parentOrganizationId** (string) - The ID of the parent organization. #### Response Example ```json { "success": true, "message": null, "parentOrganizationId": "org-12345" } ``` ``` -------------------------------- ### Create All Registered Callback API Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders This API endpoint allows for the creation of callbacks for all registered entities. It requires authentication details and the callback URL. ```APIDOC ## POST /callbacks/register ### Description Creates callbacks for all registered entities. Requires authentication credentials and the callback URL. ### Method POST ### Endpoint /callbacks/register ### Parameters #### Request Body - **authMode** (CallbackAuthModeEnum) - Required - The authentication mode for the callback. - **callbackUrl** (string) - Required - The URL to which the callback notifications will be sent. - **password** (string) - Required - The password for authentication. - **userName** (string) - Required - The username for authentication. ### Request Example ```json { "authMode": "Basic", "callbackUrl": "https://example.com/callback", "password": "securePassword123", "userName": "apiUser" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **callbacksAdded** (object) - A map of added callbacks. Keys are entity identifiers, values are callback URLs. - **callbacksExisting** (array) - A list of callbacks that already existed. - **callbacksCouldNotBeAdded** (array) - A list of callbacks that could not be added. - **message** (string) - A descriptive message about the operation. #### Response Example ```json { "success": true, "callbacksAdded": { "12345": "https://example.com/callback" }, "callbacksExisting": [], "callbacksCouldNotBeAdded": [], "message": "Callbacks registered successfully." } ``` ``` -------------------------------- ### POST /intg/callbacks/addAll Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Registers all available callbacks for the current organization at the given URL. If the URL is new, a new set of all callbacks will be set. If the URL exists, only new callbacks will be added. ```APIDOC ## POST /intg/callbacks/addAll ### Description Registers all available callbacks for the current organization at the given URL. If the URL received is a new URL, a new set of all callbacks will be set at that URL. If the URL received already exists, only callbacks not previously added will be added. ### Method POST ### Endpoint /intg/callbacks/addAll ### Parameters #### Query Parameters - **api-version** (string) - Optional - The version of the API to use. #### Request Body - **schema** (CreateAllRegisteredCallbackRequest) - Required - The request body schema for creating all registered callbacks. ### Request Example ```json { "callbackUrl": "string", "callBackType": "string" } ``` ### Response #### Success Response (200) - **description** (string) - Success message. #### Response Example ```json { "registeredCallbackId": "string", "message": "string" } ``` #### Error Response (400) - **description** (string) - Bad Request details. #### Error Response (500) - **description** (string) - Server Error details. ``` -------------------------------- ### Order Creation and Details Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders This section details the structure for creating and managing valuation orders, including properties, contacts, loan information, and custom fields. ```APIDOC ## POST /websites/api_uat_classvaluation_swagger/orders ### Description Creates a new property valuation order. ### Method POST ### Endpoint /websites/api_uat_classvaluation_swagger/orders ### Parameters #### Request Body - **orderId** (integer) - Optional - Unique identifier for the order. - **productId** (string) - Optional - Product Id. - **referenceNumber** (string) - Optional - Reference Number. - **scanPropertyId** (string) - Optional - ScanPropertyId. - **scanProjectId** (string) - Optional - ScanProjectId. - **property** (object) - Optional - Property information. - **contacts** (array) - Optional - List of contact information for the order. - **loanInfo** (object) - Optional - Loan details associated with the order. - **statusInfo** (object) - Optional - Status information for the order. - **customFields** (array) - Optional - Custom fields for the order. - **instructions** (string) - Optional - Notes or requirements specific to this order. - **purpose** (object) - Optional - The purpose of the transaction. - **occupancy** (object) - Optional - Occupancy type. - **amcName** (string) - Optional - AMC Name. - **contractPrice** (number) - Optional - Contract Price. - **rushOrder** (boolean) - Optional - Indicates if the order is a rush order. - **appraiserQuotedFee** (number) - Optional - The fee quoted by the appraiser. - **dateOfContract** (string) - Optional - The date the contract was signed. - **desktopId** (string) - Optional - Desktop Id. - **invisionURL** (string) - Optional - Invision URL. - **propertyType** (object) - Optional - The type of property. - **lender** (object) - Optional - Lender information. - **appointmentDate** (string) - Optional - The scheduled appointment date. - **dueDate** (string) - Optional - The expected completion date. - **paidDate** (string) - Optional - The date the order was paid. - **paymentDetails** (object) - Optional - Details of the payment made for the order. - **created** (string) - Required - Timestamp when the order was created. - **estimatedClosingDate** (string) - Optional - The estimated closing date. - **borrowerIntentToProceedDate** (string) - Optional - The date the borrower intends to proceed. - **servicesConfiguration** (object) - Optional - Configuration for services related to the order. - **notificationList** (array) - Optional - List of notifications for the order. ### Request Example ```json { "productId": "VAL-123", "referenceNumber": "REF-XYZ", "property": { "address": { "street1": "123 Main St", "city": "Anytown", "state": "CA", "zipCode": "90210" } }, "contacts": [ { "firstName": "John", "lastName": "Doe", "email": "john.doe@example.com", "phone": "555-123-4567", "role": "Borrower" } ], "loanInfo": { "loanNumber": "LN-987654", "loanAmount": 500000 }, "instructions": "Please expedite the appraisal.", "purpose": "Purchase", "occupancy": "Primary", "contractPrice": 750000, "rushOrder": true, "dateOfContract": "2023-10-27T10:00:00Z", "propertyType": "Single Family Residence", "lender": { "name": "Example Bank", "nmlsId": "12345" }, "dueDate": "2023-11-10T17:00:00Z", "paymentDetails": { "paymentMethod": "Credit Card", "amountPaid": 500 } } ``` ### Response #### Success Response (200) - **orderId** (integer) - The unique identifier of the created order. - **status** (string) - The current status of the order. #### Response Example ```json { "orderId": 1001, "status": "Pending" } ``` ``` -------------------------------- ### GET /websites/api_uat_classvaluation_swagger Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves attachment photo metadata. Supports filtering and pagination. ```APIDOC ## GET /websites/api_uat_classvaluation_swagger ### Description Retrieves attachment photo metadata. Supports filtering by UrlType and pagination. ### Method GET ### Endpoint /websites/api_uat_classvaluation_swagger ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of results to return. - **UrlType** (UrlTypeEnum) - Required - Specifies the type of URL to filter by. - **api-version** (string) - Optional - Specifies the API version. ### Request Example ```json { "example": "Not applicable for GET request without a body" } ``` ### Response #### Success Response (200) - **AttachmentPhotoMetadataResponseTotalList** - The schema for the response containing attachment photo metadata. #### Response Example ```json { "example": "Response body will contain attachment photo metadata based on the schema" } ``` ``` -------------------------------- ### ServicesConfigurationInfo Schema Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Provides information about the services configuration, including whether it's fully managed and a list of associated licenses. ```json { "type": "object", "properties": { "fullManaged": { "type": "boolean" }, "licensing": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseEnum" }, "nullable": true } }, "additionalProperties": false } ``` -------------------------------- ### Note Management Schemas Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Schemas for note creation responses and event configurations. ```APIDOC ## Note Management Schemas ### NoteCreateResponse This schema represents the response for a note creation request. #### Properties - `success` (boolean) - Indicates if the note creation was successful. - `noteId` (string, nullable) - The ID of the created note. - `orderId` (integer) - The ID of the order associated with the note. - `transactionId` (string, nullable) - The transaction ID for the note creation. - `message` (string, nullable) - A message providing details about the operation. ### NoteEventConfig This schema is used to configure events that trigger a note. #### Properties - `events` (array of NoteEventConfigItem, nullable) - A list of events that can trigger a note. ### NoteEventConfigItem Represents a single event configuration for triggering notes. #### Properties - `noteKey` (string, nullable) - The name of the event. - `enable` (boolean) - Specifies whether the event is enabled to trigger a note. ``` -------------------------------- ### Get Order Information Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves detailed information for a specific order using its ID. ```APIDOC ## GET /intg/orders/{orderId} ### Description Retrieves detailed information for a specific order using its ID. ### Method GET ### Endpoint /intg/orders/{orderId} ### Parameters #### Path Parameters - **orderId** (integer) - Required - The unique identifier of the order. #### Query Parameters - **api-version** (string) - Optional - The version of the API to use. ### Request Example ```json { "orderId": 12345, "api-version": "1.0" } ``` ### Response #### Success Response (200) - **OrderInfo** - Detailed information about the order. #### Response Example ```json { "orderId": 12345, "referenceNumber": "REF123", "status": "Completed", "customer": { "customerId": 789, "name": "John Doe" }, "items": [ { "productId": "PROD456", "quantity": 2 } ] } ``` ``` -------------------------------- ### Create AVM Order API Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders This API endpoint is used to create an Automated Valuation Model (AVM) order. It requires a reference ID, search type, and product name, along with optional property and owner details. ```APIDOC ## POST /orders/avm ### Description Creates an Automated Valuation Model (AVM) order for a property. ### Method POST ### Endpoint /orders/avm ### Parameters #### Query Parameters - **organizationId** (string) - Optional - The ID of the organization placing the order. #### Request Body - **productName** (ProductName) - Required - The name of the AVM product to order. - **referenceId** (string) - Required - A unique identifier for the order. - **searchType** (SearchType) - Required - The type of search to perform. - **createdBy** (CreateExternalOrderRequestUser) - Optional - Details of the user creating the order. - **addressDetail** (AddressDetail) - Optional - Detailed address information for the property. - **fullAddress** (string) - Optional - The full address of the property. - **apnDetail** (ApnDetail) - Optional - APN (Assessor's Parcel Number) details for the property. - **ownerDetail** (OwnerDetail) - Optional - Details of the property owner. - **propertyId** (integer) - Optional - The internal ID of the property. ### Request Example ```json { "productName": "BasicAVM", "referenceId": "REF-2023-10-001", "searchType": "PropertySearch", "createdBy": { "firstName": "John", "lastName": "Doe", "email": "john.doe@example.com" }, "addressDetail": { "streetNumber": "123", "streetName": "Main Street", "city": "Anytown", "state": "CA", "zipCode": "90210" }, "fullAddress": "123 Main Street, Anytown, CA 90210" } ``` ### Response #### Success Response (200) *Response details typically include an order ID and status.* #### Response Example ```json { "orderId": "AVM-ORDER-98765", "status": "Processing" } ``` ``` -------------------------------- ### GET /websites/api_uat_classvaluation_swagger/OrderDetails Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves details for a specific order. Supports various filters for order information. ```APIDOC ## GET /websites/api_uat_classvaluation_swagger/OrderDetails ### Description Retrieves details for a specific order. Supports various filters for order information. ### Method GET ### Endpoint `/websites/api_uat_classvaluation_swagger/OrderDetails` ### Parameters #### Query Parameters - **MissingDataFromReportAndMissingAMCBlankPages** (string) - Optional - Filter by missing data from report and missing AMC blank pages. - **MissingDatafromreportandMissingAMCSignaturePage** (string) - Optional - Filter by missing data from report and missing AMC signature page. - **OrderDetailsAssignmentTypeConcerns** (string) - Optional - Filter by assignment type concerns. - **OrderDetailsBorrowerName** (string) - Optional - Filter by borrower name. - **OrderDetailsEffectiveSignatureDateConcerns** (string) - Optional - Filter by effective signature date concerns. - **OrderDetailsITPLenderUpdateRequest** (string) - Optional - Filter by ITP lender update requests. - **OrderDetailsMissingOrderedFormsRevisions** (string) - Optional - Filter by missing ordered forms revisions. - **OrderDetailsPropertyAddress** (string) - Optional - Filter by property address. - **OrderDetailsWrongReport** (string) - Optional - Filter by wrong report details. - **PerAppraisersRequest** (string) - Optional - Filter by appraiser requests. - **PhotosandMLSphotosFHAMLSphotos** (string) - Optional - Filter by FHA MLS photos. - **PhotosandMLSphotosgeneric** (string) - Optional - Filter by generic MLS photos. - **PhotosandMLSphotossketchcorrections** (string) - Optional - Filter by sketch correction photos. - **ReconciliationConcerns203K** (string) - Optional - Filter by 203K reconciliation concerns. - **ReconciliationConcernsAddAdditionalClosedSaleListing** (string) - Optional - Filter by concerns related to adding additional closed sale listings. - **ReconciliationConcernsAlternativeSales** (string) - Optional - Filter by concerns related to alternative sales. - **ReconciliationConcernsCostApproach** (string) - Optional - Filter by concerns related to the cost approach in reconciliation. - **ReconciliationConcernsInspectionConcerns** (string) - Optional - Filter by inspection concerns in reconciliation. - **ReconciliationConcernsRemainingEconomicLife** (string) - Optional - Filter by concerns related to remaining economic life in reconciliation. - **ReconciliationConcernsSubjectToConcerns** (string) - Optional - Filter by subject-to concerns in reconciliation. - **ReconciliationConcernsValueRelatedConcerns** (string) - Optional - Filter by value-related concerns in reconciliation. - **SiteSubjectDetailConcernsAccessoryUnitConcerns** (string) - Optional - Filter by accessory unit concerns in site/subject details. - **SiteSubjectDetailConcernsAdverseSiteConditions** (string) - Optional - Filter by adverse site conditions in site/subject details. - **SiteSubjectDetailConcernsAttachDetach** (string) - Optional - Filter by attach/detach concerns in site/subject details. - **SiteSubjectDetailConcernsDAIRConcerns** (string) - Optional - Filter by DAIR concerns in site/subject details. - **SiteSubjectDetailConcernsDimensions** (string) - Optional - Filter by dimension concerns in site/subject details. - **SiteSubjectDetailConcernsDoesNeighborhoodConform** (string) - Optional - Filter by concerns about neighborhood conformity in site/subject details. - **SiteSubjectDetailConcernsGLABedBathConcerns** (string) - Optional - Filter by GLA bed/bath concerns in site/subject details. - **SiteSubjectDetailConcernsHighestBestUse** (string) - Optional - Filter by highest and best use concerns in site/subject details. - **SiteSubjectDetailConcernsIncorrectOccupancy** (string) - Optional - Filter by incorrect occupancy concerns in site/subject details. - **SiteSubjectDetailConcernsMarketConditions** (string) - Optional - Filter by market condition concerns in site/subject details. - **SiteSubjectDetailConcernsNeighborhoodBoundaries** (string) - Optional - Filter by neighborhood boundary concerns in site/subject details. - **SiteSubjectDetailConcernsPredominateValue** (string) - Optional - Filter by predominant value concerns in site/subject details. - **SiteSubjectDetailConcernsPresentLandUse** (string) - Optional - Filter by present land use concerns in site/subject details. - **SiteSubjectDetailConcernsPropertyOfferedforSale** (string) - Optional - Filter by concerns about property offered for sale in site/subject details. - **SiteSubjectDetailConcernsPropertyRebuiltifDestroyed** (string) - Optional - Filter by concerns about property rebuilt if destroyed in site/subject details. - **SiteSubjectDetailConcernsRETaxesandAssessments** (string) - Optional - Filter by RETaxes and assessments concerns in site/subject details. - **SiteSubjectDetailConcernsSubjectFloodInformation** (string) - Optional - Filter by subject flood information concerns in site/subject details. - **SiteSubjectDetailConcernsVerifyUtilities** (string) - Optional - Filter by utility verification concerns in site/subject details. - **SiteDetailConcernsYearBuiltConcerns** (string) - Optional - Filter by year built concerns in site details. - **SiteSubjectDetailConcernsZoningConcerns** (string) - Optional - Filter by zoning concerns in site/subject details. - **VariationsPublicorCountyRecordsAccessoryUnit** (string) - Optional - Filter by variations in public/county records for accessory units. - **VariationsPublicorCountyRecordsBedBathCount** (string) - Optional - Filter by variations in public/county records for bed/bath count. - **VariationsPublicorCountyRecordsConditionQualityRatings** (string) - Optional - Filter by variations in public/county records for condition/quality ratings. - **VariationsPublicorCountyRecordsGeocodes** (string) - Optional - Filter by variations in public/county records for geocodes. - **VariationsPublicorCountyRecordsPublicRecordsdifferfromreport** (string) - Optional - Filter by variations where public records differ from the report. ### Request Example ```json { "example": "GET /websites/api_uat_classvaluation_swagger/OrderDetails?OrderDetailsBorrowerName=John Doe" } ``` ### Response #### Success Response (200) - **OrderDetails** (object) - An object containing the details of the orders matching the filter criteria. #### Response Example ```json { "example": "{\"orderId\": \"12345\", \"borrowerName\": \"John Doe\", ...}" } ``` ``` -------------------------------- ### Services Configuration Info Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders This schema represents the current service configuration, including whether full management is enabled and the list of active licenses. ```APIDOC ## Services Configuration Info ### Description Provides information about the current configuration of services, including full management status and licensing details. ### Method N/A (Schema Definition) ### Endpoint N/A (Schema Definition) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **fullManaged** (boolean) - Indicates if the service is in full managed mode. - **licensing** (array of strings) - A list of active license identifiers, or null if none are active. #### Response Example ```json { "fullManaged": true, "licensing": ["LICENSE_A", "LICENSE_B"] } ``` ``` -------------------------------- ### GET /intg/organizations Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves a list of available organizations. This endpoint is used to search for and retrieve information about organizations within the system. ```APIDOC ## GET /intg/organizations ### Description Retrieves a list of available organizations. This endpoint is used to search for and retrieve information about organizations within the system. ### Method GET ### Endpoint /intg/organizations ### Parameters #### Query Parameters - **api-version** (string) - Optional - Specifies the API version. ### Response #### Success Response (200) - **organizations** (array) - A list of organizations. - **organizationId** (integer) - The ID of the organization. - **name** (string) - The name of the organization. #### Response Example ```json { "organizations": [ { "organizationId": 1, "name": "Example Organization 1" }, { "organizationId": 2, "name": "Example Organization 2" } ] } ``` ``` -------------------------------- ### Create User using Class External Orders API Source: https://api.uat.classvaluation.com/swagger/index This snippet shows how to create a new user within the system using the Class External Orders API. It requires an OpenAPI 3.0 specification. ```yaml OAS3 POST /intg/users Creates a new user ``` -------------------------------- ### GET /intg/{orderId}/attachments/photos-metadata Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves metadata for photo attachments associated with an order. Requires specifying the metadata source (FNMA or Freddie). ```APIDOC ## GET /intg/{orderId}/attachments/photos-metadata ### Description Retrieves metadata for photo attachments related to a specific order. This endpoint allows you to query using either FNMA or Freddie metadata standards. ### Method GET ### Endpoint `/intg/{orderId}/attachments/photos-metadata` ### Parameters #### Path Parameters - **orderId** (integer) - Required - The unique identifier of the order. #### Query Parameters - **UseMetadata** (string) - Required - Specifies the metadata source. Accepted values are 'FNMA' or 'Freddie'. - **offset** (integer) - Optional - Offset for pagination. ### Request Example ```json { "example": "No request body for GET request" } ``` ### Response #### Success Response (200) - **photos_metadata** (array) - An array of photo metadata objects. - **photo_id** (string) - Identifier for the photo. - **timestamp** (string) - Date and time the photo was taken. - **camera_make** (string) - Make of the camera. - **camera_model** (string) - Model of the camera. - **latitude** (number) - Latitude coordinate. - **longitude** (number) - Longitude coordinate. #### Response Example ```json { "photos_metadata": [ { "photo_id": "photo123", "timestamp": "2023-10-27T10:00:00Z", "camera_make": "Canon", "camera_model": "EOS R5", "latitude": 34.0522, "longitude": -118.2437 } ] } ``` ``` -------------------------------- ### Products API Source: https://api.uat.classvaluation.com/swagger/index Endpoints for searching and retrieving information about available products. ```APIDOC ## GET /intg/products ### Description Search for available products. ### Method GET ### Endpoint /intg/products ### Parameters #### Query Parameters - **name** (string) - Optional - Filter products by name. ### Response #### Success Response (200) - **Array of product objects** (array) - A list of available products. #### Response Example ```json [ { "productId": "string", "name": "string", "description": "string" } ] ``` ``` -------------------------------- ### Create User API Endpoint Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders This endpoint allows for the creation of a new user within the system. It accepts user details in JSON format and returns a success or error response. Supports multiple JSON content types and requires 'ClassValuation' security. ```json { "/intg/users": { "post": { "tags": [ "Users" ], "summary": "Creates a new user", "parameters": [ { "name": "api-version", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorModelBase" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "ClassValuation": [] } ] } } } ``` -------------------------------- ### GET /intg/orders/{orderId}/notes Source: https://api.uat.classvaluation.com/swagger/docs/v1/orders Retrieves notes available for a specific order. This endpoint allows fetching notes associated with an order, with options to filter by direction. ```APIDOC ## GET /intg/orders/{orderId}/notes ### Description Gets notes available for a specific order. ### Method GET ### Endpoint /intg/orders/{orderId}/notes ### Parameters #### Path Parameters - **orderId** (integer) - Required - Order Id. #### Query Parameters - **direction** (DirectionEnum) - Optional - Filters notes by direction. - **api-version** (string) - Optional - Specifies the API version. ### Request Example ```json { "example": "GET /intg/orders/12345/notes?direction=ASC&api-version=1.0" } ``` ### Response #### Success Response (200) - **schema** (array) - An array of note objects. #### Response Example ```json { "example": "[{\"noteId\": 1, \"text\": \"Sample note\", \"timestamp\": \"2023-10-27T10:00:00Z\"}]" } ``` ```