ShareDefault⁠

Perform various operations for Symitar parameters.

Operations⁠

getShareDefaultSelectFields⁠

POST

Execute the persistent ParameterService getShareDefaultSelectFields operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ShareDefaultShareTypeintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/getShareDefaultSelectFields

POST /nexum/627/persistent/parameter/getShareDefaultSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "ShareDefaultShareType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "SelectableFields": {
    "IncludeAllShareDefaultFields": true,
    "ShareDefaultFields": {
      "AmortizationSchd": true,
      "AmortizationSchdType": true,
      "AuthFeeOption": [
        0
      ],
      "BumpEffectiveDate": true,
      "BumpExpirationDate": true,
      "BumpRate": true,
      "CallItemSchd": true,
      "CallItemSchdType": true,
      "CappedFeesAmountCap": true,
      "CappedFeesCountCap": true,
      "CertificateNumber": true,
      "Chapter4WithholdingCode": true,
      "CheckDigits": true,
      "CloseDate": true,
      "CorporateUserTransferCode": true,
      "CreditReportingCode": true,
      "CuTotalsUseCode": true,
      "Description": true,
      "DivDisbUpdtActvtyD": true,
      "DivPostCode": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

getShareDefaultPagedListSelectFields⁠

POST

Execute the persistent ParameterService getShareDefaultPagedListSelectFields operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/getShareDefaultPagedListSelectFields

POST /nexum/627/persistent/parameter/getShareDefaultPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllShareDefaultFields": true,
    "ShareDefaultFields": {
      "AmortizationSchd": true,
      "AmortizationSchdType": true,
      "AuthFeeOption": [
        0
      ],
      "BumpEffectiveDate": true,
      "BumpExpirationDate": true,
      "BumpRate": true,
      "CallItemSchd": true,
      "CallItemSchdType": true,
      "CappedFeesAmountCap": true,
      "CappedFeesCountCap": true,
      "CertificateNumber": true,
      "Chapter4WithholdingCode": true,
      "CheckDigits": true,
      "CloseDate": true,
      "CorporateUserTransferCode": true,
      "CreditReportingCode": true,
      "CuTotalsUseCode": true,
      "Description": true,
      "DivDisbUpdtActvtyD": true,
      "DivPostCode": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

searchShareDefaultPagedSelectFields⁠

POST

Execute the persistent ParameterService searchShareDefaultPagedSelectFields operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

Path Parameters

symstringrequired: Sym number

Responses

Tokenstringoptional

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/searchShareDefaultPagedSelectFields

POST /nexum/627/persistent/parameter/searchShareDefaultPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0,
    "Token": "string"
  },
  "SelectableFields": {
    "IncludeAllShareDefaultFields": true,
    "ShareDefaultFields": {
      "AmortizationSchd": true,
      "AmortizationSchdType": true,
      "AuthFeeOption": [
        0
      ],
      "BumpEffectiveDate": true,
      "BumpExpirationDate": true,
      "BumpRate": true,
      "CallItemSchd": true,
      "CallItemSchdType": true,
      "CappedFeesAmountCap": true,
      "CappedFeesCountCap": true,
      "CertificateNumber": true,
      "Chapter4WithholdingCode": true,
      "CheckDigits": true,
      "CloseDate": true,
      "CorporateUserTransferCode": true,
      "CreditReportingCode": true,
      "CuTotalsUseCode": true,
      "Description": true,
      "DivDisbUpdtActvtyD": true,
      "DivPostCode": true
    }
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

updateShareDefaultByID⁠

POST

Execute the persistent ParameterService updateShareDefaultByID operation.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json

ShareDefaultShareTypeintegeroptional

Path Parameters

symstringrequired: Sym number

Responses

MessageIdstringoptional

POST/nexum/{sym}/persistent/parameter/updateShareDefaultByID

POST /nexum/627/persistent/parameter/updateShareDefaultByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "ShareDefaultShareType": 0,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DeviceInformation": {
    "DeviceType": "string",
    "DeviceNumber": 0
  },
  "ShareDefaultFields": {
    "AmortizationSchd": 0,
    "AmortizationSchdType": 0,
    "AuthFeeOption": [
      {
        "EntryId": 0,
        "AuthFeeOption": 0
      }
    ],
    "BumpEffectiveDate": "string",
    "BumpExpirationDate": "string",
    "BumpRate": 0,
    "CallItemSchd": 0,
    "CallItemSchdType": 0,
    "CappedFeesAmountCap": 0,
    "CappedFeesCountCap": 0,
    "CertificateNumber": "string",
    "Chapter4WithholdingCode": 0,
    "CheckDigits": "string",
    "CloseDate": "string",
    "CorporateUserTransferCode": 0,
    "CreditReportingCode": 0,
    "CuTotalsUseCode": 0,
    "Description": "string",
    "DivDisbUpdtActvtyD": 0,
    "DivPostCode": 0
  },
  "nxAttributes": {
    "customFields": {}
  }
}