LoanAppFormPkt

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getLoanAppFormPkt

post

Retrieve LoanAppFormPkt 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

LoanAppFormPktFormPacketTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getLoanAppFormPkt

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "LoanAppFormPktFormPacketType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "LoanAppFormPkt": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getLoanAppFormPkt"
}

getLoanAppFormPktSelectFields

post

Retrieve LoanAppFormPkt 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

LoanAppFormPktFormPacketTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getLoanAppFormPktSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "LoanAppFormPktFormPacketType": 0,
  "SelectableFields": {
    "LoanAppFormPktFields": {
      "FormPacketType": true,
      "Description": true,
      "SpecfileName": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "LoanAppFormPkt": {
    "DefaultPrinter": [],
    "Description": "Form Packet 00",
    "ForcePrinting": [],
    "FormPacketType": 0,
    "SpecfileName": []
  },
  "MessageId": "getLoanAppFormPktSelectFields"
}

getLoanAppFormPktPagedList

post

Retrieve LoanAppFormPkt 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/getLoanAppFormPktPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getLoanAppFormPktPagedList 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.

{
  "LoanAppFormPkt": [],
  "Token": null,
  "MessageId": "getLoanAppFormPktPagedList"
}

getLoanAppFormPktListSelectFields

post

Retrieve LoanAppFormPkt 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/getLoanAppFormPktListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "LoanAppFormPktList": [],
  "MessageId": "getLoanAppFormPktListSelectFields"
}

searchLoanAppFormPktSelectFields

post

Search LoanAppFormPkt 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/searchLoanAppFormPktSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "LoanAppFormPktList": [],
  "MessageId": "searchLoanAppFormPktSelectFields"
}

getLoanAppFormPktPagedListSelectFields

post

Retrieve LoanAppFormPkt 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/getLoanAppFormPktPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "LoanAppFormPktFields": {
      "FormPacketType": true,
      "Description": true,
      "SpecfileName": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "LoanAppFormPkt": [
    {
      "DefaultPrinter": [],
      "Description": "Form Packet 00",
      "ForcePrinting": [],
      "FormPacketType": 0,
      "SpecfileName": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getLoanAppFormPktPagedListSelectFields"
}

searchLoanAppFormPktPagedSelectFields

post

Search LoanAppFormPkt 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/searchLoanAppFormPktPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "LoanAppFormPktFields": {
      "FormPacketType": true,
      "Description": true,
      "SpecfileName": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "LoanAppFormPkt": [
    {
      "DefaultPrinter": [],
      "Description": "Form Packet 00",
      "ForcePrinting": [],
      "FormPacketType": 0,
      "SpecfileName": []
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchLoanAppFormPktPagedSelectFields"
}

updateLoanAppFormPktByID

post

Update LoanAppFormPkt 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

LoanAppFormPktFormPacketTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateLoanAppFormPktByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "LoanAppFormPktFormPacketType": 1,
  "LoanAppFormPktUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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