LoanAppFieldName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getLoanAppFieldName

post

Retrieve LoanAppFieldName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LoanAppFieldNameFieldintegerRequired

Loan App Field Name Field data

Responses

200

Successful operation.

application/json

post/getLoanAppFieldName

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "LoanAppFieldNameField": "example-value",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "LoanAppFieldName": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getLoanAppFieldName"
}

getLoanAppFieldNameSelectFields

post

Retrieve LoanAppFieldName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LoanAppFieldNameFieldintegerOptional

Loan App Field Name Field data

Responses

200

Successful operation.

application/json

post/getLoanAppFieldNameSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "LoanAppFieldNameField": 1,
  "SelectableFields": {
    "LoanAppFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  }
}

200

Successful operation.

{
  "LoanAppFieldName": {
    "Field": 1,
    "FieldName": "User Number 01"
  },
  "MessageId": "getLoanAppFieldNameSelectFields"
}

getLoanAppFieldNamePagedList

post

Retrieve LoanAppFieldName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getLoanAppFieldNamePagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "LoanAppFieldName": [],
  "Token": null,
  "MessageId": "getLoanAppFieldNamePagedList"
}

getLoanAppFieldNameListSelectFields

post

Retrieve LoanAppFieldName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getLoanAppFieldNameListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllLoanAppFieldNameFields": true
  }
}

200

Successful operation.

{
  "LoanAppFieldNameList": [],
  "MessageId": "getLoanAppFieldNameListSelectFields"
}

searchLoanAppFieldNameSelectFields

post

Search LoanAppFieldName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/searchLoanAppFieldNameSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllLoanAppFieldNameFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "LoanAppFieldNameList": [],
  "MessageId": "searchLoanAppFieldNameSelectFields"
}

getLoanAppFieldNamePagedListSelectFields

post

Retrieve LoanAppFieldName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getLoanAppFieldNamePagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "LoanAppFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  }
}

200

Successful operation.

{
  "LoanAppFieldName": [
    {
      "Field": 1,
      "FieldName": "User Number 01"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getLoanAppFieldNamePagedListSelectFields"
}

searchLoanAppFieldNamePagedSelectFields

post

Search LoanAppFieldName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchLoanAppFieldNamePagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "LoanAppFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  }
}

200

Successful operation.

{
  "LoanAppFieldName": [
    {
      "Field": 1,
      "FieldName": "User Number 01"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchLoanAppFieldNamePagedSelectFields"
}

updateLoanAppFieldNameByID

post

Update LoanAppFieldName parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LoanAppFieldNameFieldintegerOptional

Loan App Field Name Field data

Responses

200

Successful operation.

application/json

post/updateLoanAppFieldNameByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "LoanAppFieldNameField": "example-value",
  "LoanAppFieldNameUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLoanAppFieldNameByID"
}