Get V Model Relationship
get
https://server:port/spl/rest/apis/cross/v-model/vModelRelationships/{accountId}
This Operation handles the Integration Suite API to Get V Model Relationship.
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1GetVModel
Type:
Show Source
object
-
_self: string
_self
-
accessGroup: object
accessGroup
Access Group controls which users are allowed to view and update this account's information (including bills, service agreements, payments, and premises).
-
account: object
account
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed
-
customerClass: object
customerClass
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
serviceAgreements: object
serviceAgreements
Nested Schema : accessGroup
Type:
object
Access Group controls which users are allowed to view and update this account's information (including bills, service agreements, payments, and premises).
Show Source
-
_link: string
_link
-
accessGroup: string
Maximum Length:
12
Access Group controls which users are allowed to view and update this account's information (including bills, service agreements, payments, and premises).Example:***
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID is a system-assigned random number that stays with an account for life.Example:9973918199
Nested Schema : currency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed
Show Source
-
_link: string
_link
-
currencyId: string
Maximum Length:
3
Currency Code
Nested Schema : customerClass
Type:
Show Source
object
-
_link: string
_link
-
customerClass: string
(customerClass)
Nested Schema : serviceAgreement
Type:
Show Source
object
-
_link: string
_link
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
address: object
address
-
premiseId: string
Maximum Length:
10
Premise ID -
servicePoints: object
servicePoints
Nested Schema : address
Type:
Show Source
object
-
address1: string
Maximum Length:
254
The first line of the premise address.Example:1 Daily Show
-
address2: string
Maximum Length:
254
The second line of the premise address.Example:ZZRSALDO C2M
-
address3: string
Maximum Length:
254
The third line of the premise address. -
address4: string
Maximum Length:
254
The fourth line of the premise address.Example:Uniontown
-
city: string
Maximum Length:
90
The city of the premise address. -
country: object
country
-
county: object
county
-
postal: string
Maximum Length:
12
The postal code of the premise address.Example:44002
-
state: string
Maximum Length:
6
The state of the premise address.Example:OH
-
streetNumber1: string
Maximum Length:
6
The first street number line of the premise address. -
streetNumber2: string
Maximum Length:
4
The second street number line of the premise address.
Nested Schema : country
Type:
Show Source
object
-
_link: string
_link
-
country: string
Maximum Length:
3
Country
Nested Schema : county
Type:
Show Source
object
-
_link: string
_link
-
county: string
Maximum Length:
90
County
Nested Schema : servicePoint
Type:
Show Source
object
-
_link: string
_link
-
servicePointId: string
Maximum Length:
10
Service Point ID
Nested Schema : items
Type:
Show Source
object
-
deviceType: string
Maximum Length:
30
Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.Example:E-SMART-MTR
-
installEvent: object
installEvent
-
item: object
item
-
meter: object
meter
Nested Schema : installEvent
Type:
Show Source
object
-
_link: string
_link
-
installEventId: string
Maximum Length:
12
Install Event ID
Nested Schema : item
Type:
Show Source
object
-
_link: string
_link
-
itemId: string
Maximum Length:
12
Device ID
Nested Schema : meter
Type:
Show Source
object
-
_link: string
_link
-
meterId: string
Maximum Length:
12
Device ID
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.