EscrowAnalysis

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getEscrowAnalysis

post

Retrieve escrow analysis data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getEscrowAnalysis

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getEscrowAnalysis HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "EscrowAnalysis": {
    "AnalysisPastDueExceptions": 1,
    "DeficiencyGe1EscrwPayMthd": 1,
    "DeficiencyGeAmount": [
      {
        "EntryId": 1,
        "DeficiencyGeAmount": 1
      }
    ],
    "DeficiencyGeNbrOfMonths": [
      {
        "EntryId": 1,
        "DeficiencyGeNbrOfMonths": 1
      }
    ],
    "DeficiencyLt1EscrwPayMthd": 1,
    "DeficiencyLtAmount": [
      {
        "EntryId": 1,
        "DeficiencyLtAmount": 1
      }
    ],
    "DeficiencyLtNbrOfMonths": [
      {
        "EntryId": 1,
        "DeficiencyLtNbrOfMonths": 1
      }
    ],
    "EscrowOverageMinDollarAmt": 1,
    "EscrowOverageMinPercentage": 1,
    "EscrowOverageProcessingMthd": 1,
    "NewPaymentRounding": 1,
    "PaymentChangeThreshold": 1,
    "ShortageGe1EscrowPayMethd": 1,
    "ShortageGeAmount": [
      {
        "EntryId": 1,
        "ShortageGeAmount": 1
      }
    ],
    "ShortageGeNbrOfMonths": [
      {
        "EntryId": 1,
        "ShortageGeNbrOfMonths": 1
      }
    ],
    "ShortageLt1EscrowPayMethd": 1,
    "ShortageLtAmount": [
      {
        "EntryId": 1,
        "ShortageLtAmount": 1
      }
    ],
    "ShortageLtNbrOfMonths": [
      {
        "EntryId": 1,
        "ShortageLtNbrOfMonths": 1
      }
    ]
  }
}

getEscrowAnalysisSelectFields

post

Retrieve select fields for escrow analysis data.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getEscrowAnalysisSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getEscrowAnalysisSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 743

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllEscrowAnalysisFields": true,
    "EscrowAnalysisFields": {
      "AnalysisPastDueExceptions": true,
      "DeficiencyGe1EscrwPayMthd": true,
      "DeficiencyGeAmount": [
        1
      ],
      "DeficiencyGeNbrOfMonths": [
        1
      ],
      "DeficiencyLt1EscrwPayMthd": true,
      "DeficiencyLtAmount": [
        1
      ],
      "DeficiencyLtNbrOfMonths": [
        1
      ],
      "EscrowOverageMinDollarAmt": true,
      "EscrowOverageMinPercentage": true,
      "EscrowOverageProcessingMthd": true,
      "NewPaymentRounding": true,
      "PaymentChangeThreshold": true,
      "ShortageGe1EscrowPayMethd": true,
      "ShortageGeAmount": [
        1
      ],
      "ShortageGeNbrOfMonths": [
        1
      ],
      "ShortageLt1EscrowPayMethd": true,
      "ShortageLtAmount": [
        1
      ],
      "ShortageLtNbrOfMonths": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "EscrowAnalysis": {
    "AnalysisPastDueExceptions": 1,
    "DeficiencyGe1EscrwPayMthd": 1,
    "DeficiencyGeAmount": [
      {
        "EntryId": 1,
        "DeficiencyGeAmount": 1
      }
    ],
    "DeficiencyGeNbrOfMonths": [
      {
        "EntryId": 1,
        "DeficiencyGeNbrOfMonths": 1
      }
    ],
    "DeficiencyLt1EscrwPayMthd": 1,
    "DeficiencyLtAmount": [
      {
        "EntryId": 1,
        "DeficiencyLtAmount": 1
      }
    ],
    "DeficiencyLtNbrOfMonths": [
      {
        "EntryId": 1,
        "DeficiencyLtNbrOfMonths": 1
      }
    ],
    "EscrowOverageMinDollarAmt": 1,
    "EscrowOverageMinPercentage": 1,
    "EscrowOverageProcessingMthd": 1,
    "NewPaymentRounding": 1,
    "PaymentChangeThreshold": 1,
    "ShortageGe1EscrowPayMethd": 1,
    "ShortageGeAmount": [
      {
        "EntryId": 1,
        "ShortageGeAmount": 1
      }
    ],
    "ShortageGeNbrOfMonths": [
      {
        "EntryId": 1,
        "ShortageGeNbrOfMonths": 1
      }
    ],
    "ShortageLt1EscrowPayMethd": 1,
    "ShortageLtAmount": [
      {
        "EntryId": 1,
        "ShortageLtAmount": 1
      }
    ],
    "ShortageLtNbrOfMonths": [
      {
        "EntryId": 1,
        "ShortageLtNbrOfMonths": 1
      }
    ]
  }
}

updateEscrowAnalysisByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/updateEscrowAnalysisByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateEscrowAnalysisByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 955

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "EscrowAnalysisUpdatableFields": {
    "AnalysisPastDueExceptions": 1,
    "DeficiencyGe1EscrwPayMthd": 1,
    "DeficiencyGeAmount": [
      {
        "EntryId": 1,
        "DeficiencyGeAmount": 1
      }
    ],
    "DeficiencyGeNbrOfMonths": [
      {
        "EntryId": 1,
        "DeficiencyGeNbrOfMonths": 1
      }
    ],
    "DeficiencyLt1EscrwPayMthd": 1,
    "DeficiencyLtAmount": [
      {
        "EntryId": 1,
        "DeficiencyLtAmount": 1
      }
    ],
    "DeficiencyLtNbrOfMonths": [
      {
        "EntryId": 1,
        "DeficiencyLtNbrOfMonths": 1
      }
    ],
    "EscrowOverageMinDollarAmt": 1,
    "EscrowOverageMinPercentage": 1,
    "EscrowOverageProcessingMthd": 1,
    "NewPaymentRounding": 1,
    "PaymentChangeThreshold": 1,
    "ShortageGe1EscrowPayMethd": 1,
    "ShortageGeAmount": [
      {
        "EntryId": 1,
        "ShortageGeAmount": 1
      }
    ],
    "ShortageGeNbrOfMonths": [
      {
        "EntryId": 1,
        "ShortageGeNbrOfMonths": 1
      }
    ],
    "ShortageLt1EscrowPayMethd": 1,
    "ShortageLtAmount": [
      {
        "EntryId": 1,
        "ShortageLtAmount": 1
      }
    ],
    "ShortageLtNbrOfMonths": [
      {
        "EntryId": 1,
        "ShortageLtNbrOfMonths": 1
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}