Jump to

• Request
• Response

Retrieve UOMs and granularity details for SP

post

/rest/apis/customer/v-model/servicePointsCommon/servicePointDetails

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

• processDateTime: string (date-time)
  Process date time used by the system to check for the measuring component(s) where value identifier type is 'Measurement' of the installed device(s) at the service point.
• spId: string
  Maximum Length: 10

  Service Point ID is a system assigned random number that stays with a service point record.

  Example: 5555400391

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
            "example":"5555400391"
        },
        "processDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Process date time used by the system to check for the measuring component(s) where value identifier type is 'Measurement' of the installed device(s) at the service point."
        }
    },
    "xml":{
        "name":"C1SPDetails"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• processDateTime: string (date-time)
  Process date time used by the system to check for the measuring component(s) where value identifier type is 'Measurement' of the installed device(s) at the service point.
• spId: string
  Maximum Length: 10

  Service Point ID is a system assigned random number that stays with a service point record.

  Example: 5555400391

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
            "example":"5555400391"
        },
        "processDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Process date time used by the system to check for the measuring component(s) where value identifier type is 'Measurement' of the installed device(s) at the service point."
        }
    },
    "xml":{
        "name":"C1SPDetails"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1SPDetails

Type: object

Show Source

• processDateTime: string (date-time)
  Process date time used by the system to check for the measuring component(s) where value identifier type is 'Measurement' of the installed device(s) at the service point.
• spId: string
  Maximum Length: 10

  Service Point ID is a system assigned random number that stays with a service point record.

  Example: 5555400391
• uoms: object uoms
• usageDataAvailabilityIndicators: object usageDataAvailabilityIndicators

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID is a system assigned random number that stays with a service point record.",
            "example":"5555400391"
        },
        "processDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Process date time used by the system to check for the measuring component(s) where value identifier type is 'Measurement' of the installed device(s) at the service point."
        },
        "uoms":{
            "type":"object",
            "properties":{
                "uomDetails":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"List of applicable units of measure that can be displayed for the service point based on the current date."
                            }
                        }
                    }
                }
            }
        },
        "usageDataAvailabilityIndicators":{
            "type":"object",
            "properties":{
                "isDailyAvailable":{
                    "type":"string",
                    "maxLength":1,
                    "description":"Indicates if daily interval data is captured by the installed meter.",
                    "example":"true"
                },
                "isHourlyAvailable":{
                    "type":"string",
                    "maxLength":1,
                    "description":"Indicates if hourly interval data is captured by the installed meter.",
                    "example":"true"
                }
            }
        }
    },
    "xml":{
        "name":"C1SPDetails"
    }
}

Nested Schema : uoms

Type: object

Show Source

• uomDetails: array uomDetails

{
    "type":"object",
    "properties":{
        "uomDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"List of applicable units of measure that can be displayed for the service point based on the current date."
                    }
                }
            }
        }
    }
}

Nested Schema : usageDataAvailabilityIndicators

Type: object

Show Source

• isDailyAvailable: string
  Maximum Length: 1

  Indicates if daily interval data is captured by the installed meter.

  Example: true
• isHourlyAvailable: string
  Maximum Length: 1

  Indicates if hourly interval data is captured by the installed meter.

  Example: true

{
    "type":"object",
    "properties":{
        "isDailyAvailable":{
            "type":"string",
            "maxLength":1,
            "description":"Indicates if daily interval data is captured by the installed meter.",
            "example":"true"
        },
        "isHourlyAvailable":{
            "type":"string",
            "maxLength":1,
            "description":"Indicates if hourly interval data is captured by the installed meter.",
            "example":"true"
        }
    }
}

Nested Schema : uomDetails

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"List of applicable units of measure that can be displayed for the service point based on the current date."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• unitOfMeasure: string
  Maximum Length: 30

  List of applicable units of measure that can be displayed for the service point based on the current date.

{
    "type":"object",
    "properties":{
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"List of applicable units of measure that can be displayed for the service point based on the current date."
        }
    }
}

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