Jump to

• Request
• Response

Validate Start SP Selection

post

https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/startSPSelectionValidation

This operation uses the Validate SPs To Start Algorithms controls to validate the selected SPs where service is being started if Start Level control is 'Individual Services'.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  Premise ID
• serviceTaskId: string
  Maximum Length: 14

  Self-Service Task ID is the system-assigned unique identifier of the self-service task.

  Example: 69216126491457
• spsToStart: object spsToStart

{
    "type":"object",
    "properties":{
        "serviceTaskId":{
            "type":"string",
            "maxLength":14,
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "spsToStart":{
            "type":"object",
            "properties":{
                "spToStart":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "spId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSValStSpS"
    }
}

Nested Schema : spsToStart

Type: object

Show Source

• spToStart: array spToStart

{
    "type":"object",
    "properties":{
        "spToStart":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "spId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    }
                }
            }
        }
    }
}

Nested Schema : spToStart

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "spId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• spId: string
  Maximum Length: 10

  Service Point ID

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  Premise ID
• serviceTaskId: string
  Maximum Length: 14

  Self-Service Task ID is the system-assigned unique identifier of the self-service task.

  Example: 69216126491457
• spsToStart: object spsToStart

{
    "type":"object",
    "properties":{
        "serviceTaskId":{
            "type":"string",
            "maxLength":14,
            "description":"Self-Service Task ID is the system-assigned unique identifier of the self-service task.",
            "example":"69216126491457"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "spsToStart":{
            "type":"object",
            "properties":{
                "spToStart":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "spId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSValStSpS"
    }
}

Nested Schema : spsToStart

Type: object

Show Source

• spToStart: array spToStart

{
    "type":"object",
    "properties":{
        "spToStart":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "spId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    }
                }
            }
        }
    }
}

Nested Schema : spToStart

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "spId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• spId: string
  Maximum Length: 10

  Service Point ID

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1SSValStSpS

Type: object

Show Source

• messages: object messages
• validServicePointsToStart: boolean
  Valid SPs To Stop switch indicates whether or not the selected services points to stop is valid.

  Example: true

{
    "type":"object",
    "properties":{
        "validServicePointsToStart":{
            "type":"boolean",
            "description":"Valid SPs To Stop switch indicates whether or not the selected services points to stop is valid.",
            "example":"true"
        },
        "messages":{
            "type":"object",
            "properties":{
                "message":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "servicePointsToStartMessage":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Service Point Start Message is any message returned when validating the selected service points to start."
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1SSValStSpS"
    }
}

Nested Schema : messages

Type: object

Show Source

• message: array message

{
    "type":"object",
    "properties":{
        "message":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePointsToStartMessage":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Service Point Start Message is any message returned when validating the selected service points to start."
                    }
                }
            }
        }
    }
}

Nested Schema : message

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "servicePointsToStartMessage":{
                "type":"string",
                "maxLength":254,
                "description":"Service Point Start Message is any message returned when validating the selected service points to start."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• servicePointsToStartMessage: string
  Maximum Length: 254

  Service Point Start Message is any message returned when validating the selected service points to start.

{
    "type":"object",
    "properties":{
        "servicePointsToStartMessage":{
            "type":"string",
            "maxLength":254,
            "description":"Service Point Start Message is any message returned when validating the selected service points to start."
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top