Jump to

• Request
• Response

Search SA Types

post

/rest/apis/customer/admin/saTypes/search

Returns a list of valid Service Agreement Types for an input CIS Division and optional inputs of Service Type and Service Point Type.

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

• filters: object filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "servicePointType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"SP Type"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Service Type"
                },
                "cisDivision":{
                    "type":"string",
                    "maxLength":"5",
                    "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
                    "example":"CA"
                }
            }
        }
    },
    "xml":{
        "name":"C1ReSATySPTD"
    }
}

Nested Schema : filters

Type: object

Show Source

• cisDivision: string
  Maximum Length: 5

  The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.

  Example: CA
• servicePointType: string
  Maximum Length: 30

  SP Type
• serviceType: string
  Maximum Length: 30

  Service Type

{
    "type":"object",
    "properties":{
        "servicePointType":{
            "type":"string",
            "maxLength":"30",
            "description":"SP Type"
        },
        "serviceType":{
            "type":"string",
            "maxLength":"30",
            "description":"Service Type"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":"5",
            "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
            "example":"CA"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filters: object filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "servicePointType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"SP Type"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Service Type"
                },
                "cisDivision":{
                    "type":"string",
                    "maxLength":"5",
                    "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
                    "example":"CA"
                }
            }
        }
    },
    "xml":{
        "name":"C1ReSATySPTD"
    }
}

Nested Schema : filters

Type: object

Show Source

• cisDivision: string
  Maximum Length: 5

  The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.

  Example: CA
• servicePointType: string
  Maximum Length: 30

  SP Type
• serviceType: string
  Maximum Length: 30

  Service Type

{
    "type":"object",
    "properties":{
        "servicePointType":{
            "type":"string",
            "maxLength":"30",
            "description":"SP Type"
        },
        "serviceType":{
            "type":"string",
            "maxLength":"30",
            "description":"Service Type"
        },
        "cisDivision":{
            "type":"string",
            "maxLength":"5",
            "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
            "example":"CA"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1ReSATySPTD

Type: object

Show Source

• saTypes: array saTypes

{
    "type":"object",
    "properties":{
        "saTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "cisDivision":{
                        "type":"string",
                        "maxLength":"5",
                        "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
                        "example":"CA"
                    },
                    "cisDivisionDescription":{
                        "type":"string",
                        "maxLength":"1",
                        "description":"CIS Division"
                    },
                    "serviceAgreementType":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"SATYPE is Service Agreement Type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                        "example":"E-RES"
                    },
                    "serviceAgreementTypeDescription":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Description"
                    },
                    "serviceType":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Service Type"
                    },
                    "specialRoleFlag":{
                        "type":"string",
                        "enum":[
                            "BC  ",
                            "BD  ",
                            "CD  ",
                            "IN  ",
                            "LO  ",
                            "NB  ",
                            "PA  ",
                            "WO  "
                        ],
                        "description":"Special Role:\n* `BC  ` - Billable Charge,\n* `BD  ` - Bill Determinants Required,\n* `CD  ` - Cash Deposit,\n* `IN  ` - Interval,\n* `LO  ` - Loan,\n* `NB  ` - Non-billed Budget,\n* `PA  ` - Payment Arrangement,\n* `WO  ` - Write Off"
                    },
                    "specialRoleFlagDescription":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Description"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ReSATySPTD"
    }
}

Nested Schema : saTypes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "cisDivision":{
                "type":"string",
                "maxLength":"5",
                "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
                "example":"CA"
            },
            "cisDivisionDescription":{
                "type":"string",
                "maxLength":"1",
                "description":"CIS Division"
            },
            "serviceAgreementType":{
                "type":"string",
                "maxLength":"8",
                "description":"SATYPE is Service Agreement Type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                "example":"E-RES"
            },
            "serviceAgreementTypeDescription":{
                "type":"string",
                "maxLength":"60",
                "description":"Description"
            },
            "serviceType":{
                "type":"string",
                "maxLength":"30",
                "description":"Service Type"
            },
            "specialRoleFlag":{
                "type":"string",
                "enum":[
                    "BC  ",
                    "BD  ",
                    "CD  ",
                    "IN  ",
                    "LO  ",
                    "NB  ",
                    "PA  ",
                    "WO  "
                ],
                "description":"Special Role:\n* `BC  ` - Billable Charge,\n* `BD  ` - Bill Determinants Required,\n* `CD  ` - Cash Deposit,\n* `IN  ` - Interval,\n* `LO  ` - Loan,\n* `NB  ` - Non-billed Budget,\n* `PA  ` - Payment Arrangement,\n* `WO  ` - Write Off"
            },
            "specialRoleFlagDescription":{
                "type":"string",
                "maxLength":"60",
                "description":"Description"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• cisDivision: string
  Maximum Length: 5

  The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.

  Example: CA
• cisDivisionDescription: string
  Maximum Length: 1

  CIS Division
• serviceAgreementType: string
  Maximum Length: 8

  SATYPE is Service Agreement Type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

  Example: E-RES
• serviceAgreementTypeDescription: string
  Maximum Length: 60

  Description
• serviceType: string
  Maximum Length: 30

  Service Type
• specialRoleFlag: string
  Allowed Values: [ "BC ", "BD ", "CD ", "IN ", "LO ", "NB ", "PA ", "WO " ]

  Special Role: * `BC ` - Billable Charge, * `BD ` - Bill Determinants Required, * `CD ` - Cash Deposit, * `IN ` - Interval, * `LO ` - Loan, * `NB ` - Non-billed Budget, * `PA ` - Payment Arrangement, * `WO ` - Write Off
• specialRoleFlagDescription: string
  Maximum Length: 60

  Description

{
    "type":"object",
    "properties":{
        "cisDivision":{
            "type":"string",
            "maxLength":"5",
            "description":"The CIS division on SA is actually part of the SA's SA type. Because SA type controls many business rules, all business rules that are on the SA type can be thought of as being defined for a given jurisdiction and SA type combination.",
            "example":"CA"
        },
        "cisDivisionDescription":{
            "type":"string",
            "maxLength":"1",
            "description":"CIS Division"
        },
        "serviceAgreementType":{
            "type":"string",
            "maxLength":"8",
            "description":"SATYPE is Service Agreement Type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "example":"E-RES"
        },
        "serviceAgreementTypeDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"Description"
        },
        "serviceType":{
            "type":"string",
            "maxLength":"30",
            "description":"Service Type"
        },
        "specialRoleFlag":{
            "type":"string",
            "enum":[
                "BC  ",
                "BD  ",
                "CD  ",
                "IN  ",
                "LO  ",
                "NB  ",
                "PA  ",
                "WO  "
            ],
            "description":"Special Role:\n* `BC  ` - Billable Charge,\n* `BD  ` - Bill Determinants Required,\n* `CD  ` - Cash Deposit,\n* `IN  ` - Interval,\n* `LO  ` - Loan,\n* `NB  ` - Non-billed Budget,\n* `PA  ` - Payment Arrangement,\n* `WO  ` - Write Off"
        },
        "specialRoleFlagDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"Description"
        }
    }
}

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