Jump to

• Request
• Response

Adds a new scheduled sweeps

post

/scheduledsweeps

This endpoint is used to add a new scheduled sweep.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new scheduledsweeps

Root Schema : LmdTbScheduledSweepsDTO

Type: object

ScheduledSweeps DTO

Match All

Show Source

• allOf GenericDto
• object LmdTbScheduledSweepsDTO-allOf[1]

{
    "description":"ScheduledSweeps DTO",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "accountNumber":{
                    "description":"accountNumber in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":30
                },
                "branchCode":{
                    "description":"branchCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":4
                },
                "currencyCode":{
                    "description":"currencyCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":3
                },
                "customerId":{
                    "description":"customerId in Scheduled Sweeps",
                    "type":"string",
                    "pattern":"[a-zA-Z0-9]{1,20}"
                },
                "instructionDesription":{
                    "description":"instructionDesription in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":200
                },
                "instructionId":{
                    "description":"instructionId in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":10
                },
                "parentAccountNumber":{
                    "description":"parentAccountNumber in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":30
                },
                "parentBranchCode":{
                    "description":"parentBranchCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":4
                },
                "parentCurrencyCode":{
                    "description":"parentCurrencyCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":3
                },
                "productCode":{
                    "description":"productCode in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":10
                },
                "productDescription":{
                    "description":"productDescription in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":200
                },
                "structureDescription":{
                    "description":"structureDescription in Scheduled Sweeps",
                    "type":"string",
                    "maxLength":200
                },
                "structureId":{
                    "description":"structureId in Scheduled Sweeps",
                    "type":"string",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "nextRunDate":{
                    "description":"nextRunDate in Scheduled Sweeps",
                    "type":"string"
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

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

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmdTbScheduledSweepsDTO-allOf[1]

Type: object

Show Source

• accountNumber(optional): string
  Maximum Length: 30

  accountNumber in Scheduled Sweeps
• branchCode(optional): string
  Maximum Length: 4

  branchCode in Scheduled Sweeps
• currencyCode(optional): string
  Maximum Length: 3

  currencyCode in Scheduled Sweeps
• customerId(optional): string
  Pattern: [a-zA-Z0-9]{1,20}

  customerId in Scheduled Sweeps
• instructionDesription(optional): string
  Maximum Length: 200

  instructionDesription in Scheduled Sweeps
• instructionId(optional): string
  Maximum Length: 10

  instructionId in Scheduled Sweeps
• nextRunDate(optional): string
  nextRunDate in Scheduled Sweeps
• parentAccountNumber(optional): string
  Maximum Length: 30

  parentAccountNumber in Scheduled Sweeps
• parentBranchCode(optional): string
  Maximum Length: 4

  parentBranchCode in Scheduled Sweeps
• parentCurrencyCode(optional): string
  Maximum Length: 3

  parentCurrencyCode in Scheduled Sweeps
• productCode(optional): string
  Maximum Length: 10

  productCode in Scheduled Sweeps
• productDescription(optional): string
  Maximum Length: 200

  productDescription in Scheduled Sweeps
• structureDescription(optional): string
  Maximum Length: 200

  structureDescription in Scheduled Sweeps
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

  structureId in Scheduled Sweeps

{
    "type":"object",
    "properties":{
        "accountNumber":{
            "description":"accountNumber in Scheduled Sweeps",
            "type":"string",
            "maxLength":30
        },
        "branchCode":{
            "description":"branchCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":4
        },
        "currencyCode":{
            "description":"currencyCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":3
        },
        "customerId":{
            "description":"customerId in Scheduled Sweeps",
            "type":"string",
            "pattern":"[a-zA-Z0-9]{1,20}"
        },
        "instructionDesription":{
            "description":"instructionDesription in Scheduled Sweeps",
            "type":"string",
            "maxLength":200
        },
        "instructionId":{
            "description":"instructionId in Scheduled Sweeps",
            "type":"string",
            "maxLength":10
        },
        "parentAccountNumber":{
            "description":"parentAccountNumber in Scheduled Sweeps",
            "type":"string",
            "maxLength":30
        },
        "parentBranchCode":{
            "description":"parentBranchCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":4
        },
        "parentCurrencyCode":{
            "description":"parentCurrencyCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":3
        },
        "productCode":{
            "description":"productCode in Scheduled Sweeps",
            "type":"string",
            "maxLength":10
        },
        "productDescription":{
            "description":"productDescription in Scheduled Sweeps",
            "type":"string",
            "maxLength":200
        },
        "structureDescription":{
            "description":"structureDescription in Scheduled Sweeps",
            "type":"string",
            "maxLength":200
        },
        "structureId":{
            "description":"structureId in Scheduled Sweeps",
            "type":"string",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "nextRunDate":{
            "description":"nextRunDate in Scheduled Sweeps",
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created Scheduled Sweeps

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

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

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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