getFieldByCompanyUserIdUsingGET (Get)

Get	getFieldByCompanyUserIdUsingGET

In This Topic

Resource Path: /rest/getDynamicFields/{companyId}/{userId}

Summary

This method retrieves the list of custom fields for an LOS specified by the companyId path parameter.

Parameters

Name	Description	Data Type
companyId	The unique Lender Price system ID for the LOS for which available custom fields are to be retrieved. Required	string
userId	The unique Lender Price system ID for the third-party Loan Officer that is requesting the list of available custom fields.	string

Name

Description

Data Type

companyId

The unique Lender Price system ID for the LOS for which available custom fields are to be retrieved.

Required

string

userId

The unique Lender Price system ID for the third-party Loan Officer that is requesting the list of available custom fields.

string

200 Response

The response body is of type Array[FieldProperty].

Example

The following code samples illustrate a typical request and response payload to retrieve the list of available custom fields for a LOS identified using its Lender Price companyId value.

Sample Request

Json

GET https://uat.lenderprice.com/rest/getDynamicFields/5**********************9/p****r

Sample Response

The response payload comprises an array of type [FieldProperty].

Json

[
  {
    "id": "5**********************9",
    "createdBy": "p****r",
    "creationDate": "2020-04-14T20:50:21.000Z",
    "modifiedBy": "o*******a",
    "modifiedDate": "2023-12-01T18:46:39.699Z",
    "name": "FHA Case Assignement Date",
    "tags": [],
    "fieldId": "FHACASEASSIGNDATE",
    "type": "DateRange",
    "addValueAsAdjustmentTag": false,
    "validator": {
      "@class": "com.cre8techlabs.entity.rate.adjustment.fields.DateRangeValidator",
      "id": "5**********************a",
      "reversed": false,
      "range": {
        "@class": "com.cre8techlabs.entity.range.DateRangeLeGt",
        "from": null,
        "to": null,
        "null": true
      },
      "type": "DateRange",
      "init": false
    }
  },
  {
    "id": "5**********************b",
    "createdBy": "p****r",
    "creationDate": "2020-04-14T20:50:21.000Z",
    "modifiedBy": "o*******a",
    "modifiedDate": "2023-12-01T18:46:39.746Z",
    "name": "FHA Endorsement Date",
    "tags": [],
    "fieldId": "FHAENDORSEMENTDATE",
    "type": "DateRange",
    "addValueAsAdjustmentTag": false,
    "validator": {
      "@class": "com.cre8techlabs.entity.rate.adjustment.fields.DateRangeValidator",
      "id": "5**********************c",
      "reversed": false,
      "range": {
        "@class": "com.cre8techlabs.entity.range.DateRangeLeGt",
        "from": null,
        "to": null,
        "null": true
      },
      "type": "DateRange",
      "init": false
    }
  },
  {
    "id": "5**********************d",
    "createdBy": "p****r",
    "creationDate": "2020-04-14T20:50:21.000Z",
    "modifiedBy": "o*******a",
    "modifiedDate": "2023-12-01T18:46:39.783Z",
    "name": "Unit",
    "tags": [],
    "fieldId": "PROPERTYUNIT",
    "path": "search.property.numberOfUnit",
    "type": "NumberRange",
    "addValueAsAdjustmentTag": false,
    "validator": {
      "@class": "com.cre8techlabs.entity.rate.adjustment.fields.IntRangeValidator",
      "id": "5**********************e",
      "reversed": false,
      "rangeV2": {
        "@class": "com.cre8techlabs.entity.range.IntegerRangeLeGt",
        "from": null,
        "to": null
      },
      "range": {
        "@class": "com.cre8techlabs.entity.range.IntegerRangeLeGt",
        "from": null,
        "to": null
      },
      "type": "NumberRange",
      "init": false
    }
  }
 ]

Fault Responses

Fault	Description
401	Unauthorized
403	Forbidden
404	Not Found