Jump to

• Request
• Response

Update the StatementPreferences of the loan origination/restructuring application

post

/loanapplication-services/service/api/v1/statementpreferences/{applicationNumber}

This operation updates the StatementPreferences of the loan origination/restructuring application of the given application number using LoanOriginationApplication Service.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationNumber(required): string
  application number of the loan origination/restructuring application

Body ()

Request Body containing the Statement Preferences details of the application number

Root Schema : StatementPreferencesModel

Type: object

StatementPreferences model

Match All

Show Source

• allOf GenericDatasegmentModel
• object StatementPreferencesModel-allOf[1]

{
    "description":"StatementPreferences model",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDatasegmentModel"
        },
        {
            "type":"object",
            "properties":{
                "cycleCode":{
                    "description":"Cycle code of the StatementPreferences",
                    "type":"string",
                    "maxLength":"22"
                },
                "day":{
                    "description":"Day of the StatementPreferences",
                    "type":"string"
                },
                "type":{
                    "description":"Type of the StatementPreferences",
                    "type":"string",
                    "maxLength":"20"
                }
            }
        }
    ]
}

Nested Schema : GenericDatasegmentModel

Match All

Show Source

• object GenericDatasegmentModel-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDatasegmentModel-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : StatementPreferencesModel-allOf[1]

Type: object

Show Source

• cycleCode: string
  Maximum Length: 22

  Cycle code of the StatementPreferences
• day: string
  Day of the StatementPreferences
• type: string
  Maximum Length: 20

  Type of the StatementPreferences

{
    "type":"object",
    "properties":{
        "cycleCode":{
            "description":"Cycle code of the StatementPreferences",
            "type":"string",
            "maxLength":"22"
        },
        "day":{
            "description":"Day of the StatementPreferences",
            "type":"string"
        },
        "type":{
            "description":"Type of the StatementPreferences",
            "type":"string",
            "maxLength":"20"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated StatementPreferences

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: ResponseResourceSupport
• messages: object ResponseDto
  ResponseDto model

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Match All

Show Source

• object ResponseResourceSupport-allOf[0]
  Discriminator: resouce_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resouce_type"
        }
    ]
}

Nested Schema : ResponseDto

Type: object

ResponseDto model

Show Source

• codes: string
  Codes
• httpStatusCode: array httpStatusCode
  Schedule Details
• keyId: string
  KeyId
• overrideAuthLevelsReqd: string
  OverrideAuthLevelsReqd
• requestId: string
  RequestId
• status: string
  Status

{
    "description":"ResponseDto model",
    "properties":{
        "keyId":{
            "description":"KeyId",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "codes":{
            "description":"Codes",
            "type":"string"
        },
        "httpStatusCode":{
            "type":"array",
            "description":"Schedule Details",
            "items":{
                "$ref":"#/definitions/responseCodes"
            }
        },
        "overrideAuthLevelsReqd":{
            "description":"OverrideAuthLevelsReqd",
            "type":"string"
        },
        "requestId":{
            "description":"RequestId",
            "type":"string"
        }
    }
}

Nested Schema : ResponseResourceSupport-allOf[0]

Type: object

Discriminator: resouce_type

Nested Schema : httpStatusCode

Type: array

Schedule Details

Show Source

• Array of: object responseCodes
  ResponseCodes

{
    "type":"array",
    "description":"Schedule Details",
    "items":{
        "$ref":"#/definitions/responseCodes"
    }
}

Nested Schema : responseCodes

Type: object

ResponseCodes

Show Source

• code: string
  Code
• desc: string
  Description
• error: string
  Error
• info: string
  Info
• language: string
  Language
• override: string
  Override
• type: string
  Type

{
    "description":"ResponseCodes",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "language":{
            "description":"Language",
            "type":"string"
        },
        "error":{
            "description":"Error",
            "type":"string"
        },
        "override":{
            "description":"Override",
            "type":"string"
        },
        "info":{
            "description":"Info",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top