DebtRatio

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getDebtRatio

post

Retrieve debt ratio information.

Authorizations
Body
DebtRatioTypeintegerRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getDebtRatio HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 142

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

Successful operation.

{
  "DebtRatio": {
    "FieldNo": [
      {
        "EntryId": 1,
        "FieldNo": 1
      }
    ],
    "FieldUse": [
      {
        "EntryId": 1,
        "FieldUse": 1
      }
    ],
    "PayFactor": 1,
    "PayUseCode": 1,
    "Type": 1
  }
}

getDebtRatioSelectFields

post

Retrieve select fields for a specific debt ratio.

Authorizations
Body
DebtRatioTypeintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getDebtRatioSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DebtRatioType": 1,
  "SelectableFields": {
    "IncludeAllDebtRatioFields": true,
    "DebtRatioFields": {
      "FieldNo": [
        1
      ],
      "FieldUse": [
        1
      ],
      "PayFactor": true,
      "PayUseCode": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "DebtRatio": {
    "FieldNo": [
      {
        "EntryId": 1,
        "FieldNo": 1
      }
    ],
    "FieldUse": [
      {
        "EntryId": 1,
        "FieldUse": 1
      }
    ],
    "PayFactor": 1,
    "PayUseCode": 1,
    "Type": 1
  }
}

getDebtRatioPagedList

post

Retrieve debt ratios in a paged list.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getDebtRatioPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "DebtRatio": [
    {
      "FieldNo": [
        {
          "EntryId": 1,
          "FieldNo": 1
        }
      ],
      "FieldUse": [
        {
          "EntryId": 1,
          "FieldUse": 1
        }
      ],
      "PayFactor": 1,
      "PayUseCode": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}

getDebtRatioListSelectFields

post

Retrieve a list of select fields for debt ratios.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getDebtRatioListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllDebtRatioFields": true,
    "DebtRatioFields": {
      "FieldNo": [
        1
      ],
      "FieldUse": [
        1
      ],
      "PayFactor": true,
      "PayUseCode": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "DebtRatioList": {
    "hasReachedMaximumListSize": true,
    "DebtRatio": [
      {
        "FieldNo": [
          {
            "EntryId": 1,
            "FieldNo": 1
          }
        ],
        "FieldUse": [
          {
            "EntryId": 1,
            "FieldUse": 1
          }
        ],
        "PayFactor": 1,
        "PayUseCode": 1,
        "Type": 1
      }
    ]
  }
}

searchDebtRatioSelectFields

post

Field for selecting various options related to searchdebtratioselectfields

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchDebtRatioSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllDebtRatioFields": true,
    "DebtRatioFields": {
      "FieldNo": [
        1
      ],
      "FieldUse": [
        1
      ],
      "PayFactor": true,
      "PayUseCode": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "DebtRatioList": {
    "hasReachedMaximumListSize": true,
    "DebtRatio": [
      {
        "FieldNo": [
          {
            "EntryId": 1,
            "FieldNo": 1
          }
        ],
        "FieldUse": [
          {
            "EntryId": 1,
            "FieldUse": 1
          }
        ],
        "PayFactor": 1,
        "PayUseCode": 1,
        "Type": 1
      }
    ]
  }
}

getDebtRatioPagedListSelectFields

post

Retrieve a paged list of select fields for debt ratios.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getDebtRatioPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 368

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllDebtRatioFields": true,
    "DebtRatioFields": {
      "FieldNo": [
        1
      ],
      "FieldUse": [
        1
      ],
      "PayFactor": true,
      "PayUseCode": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "DebtRatio": [
    {
      "FieldNo": [
        {
          "EntryId": 1,
          "FieldNo": 1
        }
      ],
      "FieldUse": [
        {
          "EntryId": 1,
          "FieldUse": 1
        }
      ],
      "PayFactor": 1,
      "PayUseCode": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}

searchDebtRatioPagedSelectFields

post

Field for selecting various options related to searchdebtratiopagedselectfields

Authorizations
Body
QuerystringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchDebtRatioPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 383

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllDebtRatioFields": true,
    "DebtRatioFields": {
      "FieldNo": [
        1
      ],
      "FieldUse": [
        1
      ],
      "PayFactor": true,
      "PayUseCode": true,
      "Type": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "DebtRatio": [
    {
      "FieldNo": [
        {
          "EntryId": 1,
          "FieldNo": 1
        }
      ],
      "FieldUse": [
        {
          "EntryId": 1,
          "FieldUse": 1
        }
      ],
      "PayFactor": 1,
      "PayUseCode": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}

updateDebtRatioByID

post

Update Debt Ratio by ID

Authorizations
Body
DebtRatioTypeintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/updateDebtRatioByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "DebtRatioType": 1,
  "DebtRatioUpdatableFields": {
    "FieldNo": [
      {
        "EntryId": 1,
        "FieldNo": 1
      }
    ],
    "FieldUse": [
      {
        "EntryId": 1,
        "FieldUse": 1
      }
    ],
    "PayFactor": 1,
    "PayUseCode": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?