Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

LnSegmentDefault

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getLnSegmentDefault

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
LnSegmentDefaultSegmentTypeintegerRequired

LnSegmentDefaultSegmentType data

Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LnSegmentDefaultSegmentType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "LnSegmentDefault": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getLnSegmentDefault"
}

getLnSegmentDefaultSelectFields

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
LnSegmentDefaultSegmentTypeintegerOptional

LnSegmentDefaultSegmentType data

Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "LnSegmentDefaultSegmentType": 0,
  "SelectableFields": {
    "LnSegmentDefaultFields": {
      "SegmentType": true,
      "Description": true,
      "InterestRate": true
    }
  }
}
200

Successful operation.

{
  "LnSegmentDefault": {
    "Description": "Segment Type 0000",
    "InterestRate": "0.000",
    "SegmentType": 0
  },
  "MessageId": "getLnSegmentDefaultSelectFields"
}

getLnSegmentDefaultPagedList

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "LnSegmentDefault": [],
  "Token": null,
  "MessageId": "getLnSegmentDefaultPagedList"
}

getLnSegmentDefaultListSelectFields

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllLnSegmentDefaultFields": true
  }
}
200

Successful operation.

{
  "LnSegmentDefaultList": [],
  "MessageId": "getLnSegmentDefaultListSelectFields"
}

searchLnSegmentDefaultSelectFields

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllLnSegmentDefaultFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "LnSegmentDefaultList": [],
  "MessageId": "searchLnSegmentDefaultSelectFields"
}

getLnSegmentDefaultPagedListSelectFields

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "LnSegmentDefaultFields": {
      "SegmentType": true,
      "Description": true,
      "InterestRate": true
    }
  }
}
200

Successful operation.

{
  "LnSegmentDefault": [
    {
      "Description": "Segment Type 0000",
      "InterestRate": "0.000",
      "SegmentType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getLnSegmentDefaultPagedListSelectFields"
}

searchLnSegmentDefaultPagedSelectFields

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "LnSegmentDefaultFields": {
      "SegmentType": true,
      "Description": true,
      "InterestRate": true
    }
  }
}
200

Successful operation.

{
  "LnSegmentDefault": [
    {
      "Description": "Segment Type 0000",
      "InterestRate": "0.000",
      "SegmentType": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchLnSegmentDefaultPagedSelectFields"
}

updateLnSegmentDefaultByID

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
LnSegmentDefaultSegmentTypeintegerOptional

LnSegmentDefaultSegmentType data

Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "LnSegmentDefaultSegmentType": 1,
  "LnSegmentDefaultUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateLnSegmentDefaultByID"
}
PreviousLateChg
NextLoanAppCopiedFlds

Last updated

Was this helpful?