Jump to

• Request
• Response

Search Service Point

post

/rest/apis/customer/v-model/servicePointSearch/

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

• accountId: string
  Maximum Length: 10

  Account ID defines the account that is financially responsible for the service agreement.

  Example: 5922116763
• filters: object filters
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit determines the page size, or maximum number of results, of the search query.

  Example: 20
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset determines the starting point of results to return for the search query.

  Example: 0
• personId: string
  Maximum Length: 10

  Person ID is the system-assigned, unique identifier for persons related to the account.
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier for the primary premise associated with the service agreement.

  Example: 3364881208

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier for the primary premise associated with the service agreement.",
            "example":"3364881208"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID defines the account that is financially responsible for the service agreement.",
            "example":"5922116763"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is the system-assigned, unique identifier for persons related to the account."
        },
        "filters":{
            "type":"object",
            "properties":{
                "searchText":{
                    "type":"string",
                    "maxLength":200,
                    "description":"Search Text flag is used to further filter by premise  id, person id or account id provided in inputs.",
                    "example":"1 1 North-East"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the Service Agreement type.",
                    "example":"E"
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit determines the page size, or maximum number of results, of the search query.",
            "example":"20"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset determines the starting point of results to return for the search query.",
            "example":"0"
        }
    },
    "xml":{
        "name":"C1ServPtSrch"
    }
}

Nested Schema : filters

Type: object

Show Source

• searchText: string
  Maximum Length: 200

  Search Text flag is used to further filter by premise id, person id or account id provided in inputs.

  Example: 1 1 North-East
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the Service Agreement type.

  Example: E

{
    "type":"object",
    "properties":{
        "searchText":{
            "type":"string",
            "maxLength":200,
            "description":"Search Text flag is used to further filter by premise  id, person id or account id provided in inputs.",
            "example":"1 1 North-East"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the Service Agreement type.",
            "example":"E"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID defines the account that is financially responsible for the service agreement.

  Example: 5922116763
• filters: object filters
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit determines the page size, or maximum number of results, of the search query.

  Example: 20
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset determines the starting point of results to return for the search query.

  Example: 0
• personId: string
  Maximum Length: 10

  Person ID is the system-assigned, unique identifier for persons related to the account.
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier for the primary premise associated with the service agreement.

  Example: 3364881208

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier for the primary premise associated with the service agreement.",
            "example":"3364881208"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID defines the account that is financially responsible for the service agreement.",
            "example":"5922116763"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is the system-assigned, unique identifier for persons related to the account."
        },
        "filters":{
            "type":"object",
            "properties":{
                "searchText":{
                    "type":"string",
                    "maxLength":200,
                    "description":"Search Text flag is used to further filter by premise  id, person id or account id provided in inputs.",
                    "example":"1 1 North-East"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the Service Agreement type.",
                    "example":"E"
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit determines the page size, or maximum number of results, of the search query.",
            "example":"20"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset determines the starting point of results to return for the search query.",
            "example":"0"
        }
    },
    "xml":{
        "name":"C1ServPtSrch"
    }
}

Nested Schema : filters

Type: object

Show Source

• searchText: string
  Maximum Length: 200

  Search Text flag is used to further filter by premise id, person id or account id provided in inputs.

  Example: 1 1 North-East
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the Service Agreement type.

  Example: E

{
    "type":"object",
    "properties":{
        "searchText":{
            "type":"string",
            "maxLength":200,
            "description":"Search Text flag is used to further filter by premise  id, person id or account id provided in inputs.",
            "example":"1 1 North-East"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the Service Agreement type.",
            "example":"E"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1ServPtSrch

Type: object

Show Source

• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit determines the page size, or maximum number of results, of the search query.

  Example: 20
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset determines the starting point of results to return for the search query.

  Example: 0
• servicePointList: array servicePointList
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  The total number of records returned in a service point search.

  Example: 3

{
    "type":"object",
    "properties":{
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit determines the page size, or maximum number of results, of the search query.",
            "example":"20"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset determines the starting point of results to return for the search query.",
            "example":"0"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"The total number of records returned in a service point search.",
            "example":"3"
        },
        "servicePointList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID is a system assigned random number that defines a service point record."
                    },
                    "servicePointType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The Service Point Type defines specific types of service points at which service is delivered.",
                        "example":"E-RES (C2MO)"
                    },
                    "servicePointTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"The description for the service point type that can be displayed to customers.",
                        "example":"Electric-Residential (C2MO)"
                    },
                    "timeZone":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The Olson timezone name as defined in the Utility's installation setting that indicates when the usage occurred."
                    },
                    "timeZoneName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"The description of the time zone that can be displayed to customers."
                    },
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the Service Agreement type.",
                        "example":"E"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"The description for the service type that can be displayed to customers.",
                        "example":"Electric"
                    },
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID is a system-assigned, unique identifier for the primary premise associated with the service agreement.",
                        "example":"3364881208"
                    },
                    "formattedAddress":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The premise address in a formatted presentation that can be displayed to customers.",
                        "example":"129 Sutter St, San Francisco, CA, 94104"
                    },
                    "ccbServicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID",
                        "example":"9658065725"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ServPtSrch"
    }
}

Nested Schema : servicePointList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "servicePointId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID is a system assigned random number that defines a service point record."
            },
            "servicePointType":{
                "type":"string",
                "maxLength":30,
                "description":"The Service Point Type defines specific types of service points at which service is delivered.",
                "example":"E-RES (C2MO)"
            },
            "servicePointTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"The description for the service point type that can be displayed to customers.",
                "example":"Electric-Residential (C2MO)"
            },
            "timeZone":{
                "type":"string",
                "maxLength":10,
                "description":"The Olson timezone name as defined in the Utility's installation setting that indicates when the usage occurred."
            },
            "timeZoneName":{
                "type":"string",
                "maxLength":50,
                "description":"The description of the time zone that can be displayed to customers."
            },
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type defines the type of service associated with the Service Agreement type.",
                "example":"E"
            },
            "serviceTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"The description for the service type that can be displayed to customers.",
                "example":"Electric"
            },
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"Premise ID is a system-assigned, unique identifier for the primary premise associated with the service agreement.",
                "example":"3364881208"
            },
            "formattedAddress":{
                "type":"string",
                "maxLength":254,
                "description":"The premise address in a formatted presentation that can be displayed to customers.",
                "example":"129 Sutter St, San Francisco, CA, 94104"
            },
            "ccbServicePointId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID",
                "example":"9658065725"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ccbServicePointId: string
  Maximum Length: 10

  Service Point ID

  Example: 9658065725
• formattedAddress: string
  Maximum Length: 254

  The premise address in a formatted presentation that can be displayed to customers.

  Example: 129 Sutter St, San Francisco, CA, 94104
• premiseId: string
  Maximum Length: 10

  Premise ID is a system-assigned, unique identifier for the primary premise associated with the service agreement.

  Example: 3364881208
• servicePointId: string
  Maximum Length: 10

  Service Point ID is a system assigned random number that defines a service point record.
• servicePointType: string
  Maximum Length: 30

  The Service Point Type defines specific types of service points at which service is delivered.

  Example: E-RES (C2MO)
• servicePointTypeDescription: string
  Maximum Length: 60

  The description for the service point type that can be displayed to customers.

  Example: Electric-Residential (C2MO)
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the Service Agreement type.

  Example: E
• serviceTypeDescription: string
  Maximum Length: 60

  The description for the service type that can be displayed to customers.

  Example: Electric
• timeZone: string
  Maximum Length: 10

  The Olson timezone name as defined in the Utility's installation setting that indicates when the usage occurred.
• timeZoneName: string
  Maximum Length: 50

  The description of the time zone that can be displayed to customers.

{
    "type":"object",
    "properties":{
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is a system assigned random number that defines a service point record."
        },
        "servicePointType":{
            "type":"string",
            "maxLength":30,
            "description":"The Service Point Type defines specific types of service points at which service is delivered.",
            "example":"E-RES (C2MO)"
        },
        "servicePointTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The description for the service point type that can be displayed to customers.",
            "example":"Electric-Residential (C2MO)"
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"The Olson timezone name as defined in the Utility's installation setting that indicates when the usage occurred."
        },
        "timeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"The description of the time zone that can be displayed to customers."
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the Service Agreement type.",
            "example":"E"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The description for the service type that can be displayed to customers.",
            "example":"Electric"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID is a system-assigned, unique identifier for the primary premise associated with the service agreement.",
            "example":"3364881208"
        },
        "formattedAddress":{
            "type":"string",
            "maxLength":254,
            "description":"The premise address in a formatted presentation that can be displayed to customers.",
            "example":"129 Sutter St, San Francisco, CA, 94104"
        },
        "ccbServicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID",
            "example":"9658065725"
        }
    }
}

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