Jump to

• Request
• Response

Get V Model Relationship

get

https://server:port/spl/rest/apis/cross/v-model/vModelRelationships/{accountId}

Request

Path Parameters

• accountId(required): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1GetVModel

Type: object

Show Source

• _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 ` - Put

  Example: GET
• serviceAgreements: object serviceAgreements

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put",
            "example":"GET"
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID is a system-assigned random number that stays with an account for life.",
                    "example":"9973918199"
                }
            }
        },
        "customerClass":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "customerClass":{
                    "type":"string",
                    "description":"(customerClass)"
                }
            }
        },
        "accessGroup":{
            "type":"object",
            "description":"Access Group controls which users are allowed to view and update this account's information (including bills, service agreements, payments, and premises).",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accessGroup":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Access Group controls which users are allowed to view and update this account's information (including bills, service agreements, payments, and premises).",
                    "example":"***"
                }
            }
        },
        "currency":{
            "type":"object",
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "currencyId":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                }
            }
        },
        "serviceAgreements":{
            "type":"object",
            "properties":{
                "serviceAgreementsList":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "serviceAgreement":{
                                        "type":"object",
                                        "properties":{
                                            "_link":{
                                                "type":"string",
                                                "description":"_link"
                                            },
                                            "serviceAgreementId":{
                                                "type":"string",
                                                "maxLength":10,
                                                "description":"Service Agreement"
                                            }
                                        }
                                    },
                                    "premises":{
                                        "type":"object",
                                        "properties":{
                                            "premisesList":{
                                                "type":"object",
                                                "properties":{
                                                    "_data":{
                                                        "type":"array",
                                                        "items":{
                                                            "type":"object",
                                                            "properties":{
                                                                "premise":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "_link":{
                                                                            "type":"string",
                                                                            "description":"_link"
                                                                        },
                                                                        "premiseId":{
                                                                            "type":"string",
                                                                            "maxLength":10,
                                                                            "description":"Premise ID"
                                                                        },
                                                                        "address":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "address1":{
                                                                                    "type":"string",
                                                                                    "maxLength":254,
                                                                                    "description":"The first line of the premise address.",
                                                                                    "example":"1 Daily Show"
                                                                                },
                                                                                "address2":{
                                                                                    "type":"string",
                                                                                    "maxLength":254,
                                                                                    "description":"The second line of the premise address.",
                                                                                    "example":"ZZRSALDO C2M"
                                                                                },
                                                                                "address3":{
                                                                                    "type":"string",
                                                                                    "maxLength":254,
                                                                                    "description":"The third line of the premise address."
                                                                                },
                                                                                "address4":{
                                                                                    "type":"string",
                                                                                    "maxLength":254,
                                                                                    "description":"The fourth line of the premise address.",
                                                                                    "example":"Uniontown"
                                                                                },
                                                                                "city":{
                                                                                    "type":"string",
                                                                                    "maxLength":90,
                                                                                    "description":"The city of the premise address."
                                                                                },
                                                                                "streetNumber1":{
                                                                                    "type":"string",
                                                                                    "maxLength":6,
                                                                                    "description":"The first street number line of the premise address."
                                                                                },
                                                                                "streetNumber2":{
                                                                                    "type":"string",
                                                                                    "maxLength":4,
                                                                                    "description":"The second street number line of the premise address."
                                                                                },
                                                                                "county":{
                                                                                    "type":"object",
                                                                                    "properties":{
                                                                                        "_link":{
                                                                                            "type":"string",
                                                                                            "description":"_link"
                                                                                        },
                                                                                        "county":{
                                                                                            "type":"string",
                                                                                            "maxLength":90,
                                                                                            "description":"County"
                                                                                        }
                                                                                    }
                                                                                },
                                                                                "postal":{
                                                                                    "type":"string",
                                                                                    "maxLength":12,
                                                                                    "description":"The postal code of the premise address.",
                                                                                    "example":"44002"
                                                                                },
                                                                                "state":{
                                                                                    "type":"string",
                                                                                    "maxLength":6,
                                                                                    "description":"The state of the premise address.",
                                                                                    "example":"OH"
                                                                                },
                                                                                "country":{
                                                                                    "type":"object",
                                                                                    "properties":{
                                                                                        "_link":{
                                                                                            "type":"string",
                                                                                            "description":"_link"
                                                                                        },
                                                                                        "country":{
                                                                                            "type":"string",
                                                                                            "maxLength":3,
                                                                                            "description":"Country"
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        },
                                                                        "servicePoints":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "servicePointsList":{
                                                                                    "type":"object",
                                                                                    "properties":{
                                                                                        "_data":{
                                                                                            "type":"array",
                                                                                            "items":{
                                                                                                "type":"object",
                                                                                                "properties":{
                                                                                                    "servicePoint":{
                                                                                                        "type":"object",
                                                                                                        "properties":{
                                                                                                            "_link":{
                                                                                                                "type":"string",
                                                                                                                "description":"_link"
                                                                                                            },
                                                                                                            "servicePointId":{
                                                                                                                "type":"string",
                                                                                                                "maxLength":10,
                                                                                                                "description":"Service Point ID"
                                                                                                            }
                                                                                                        }
                                                                                                    },
                                                                                                    "installEvents":{
                                                                                                        "type":"object",
                                                                                                        "properties":{
                                                                                                            "installEventsList":{
                                                                                                                "type":"object",
                                                                                                                "properties":{
                                                                                                                    "_data":{
                                                                                                                        "type":"array",
                                                                                                                        "items":{
                                                                                                                            "type":"object",
                                                                                                                            "properties":{
                                                                                                                                "installEvent":{
                                                                                                                                    "type":"object",
                                                                                                                                    "properties":{
                                                                                                                                        "_link":{
                                                                                                                                            "type":"string",
                                                                                                                                            "description":"_link"
                                                                                                                                        },
                                                                                                                                        "installEventId":{
                                                                                                                                            "type":"string",
                                                                                                                                            "maxLength":12,
                                                                                                                                            "description":"Install Event ID"
                                                                                                                                        }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                "deviceType":{
                                                                                                                                    "type":"string",
                                                                                                                                    "maxLength":30,
                                                                                                                                    "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                                                                                    "example":"E-SMART-MTR"
                                                                                                                                },
                                                                                                                                "meter":{
                                                                                                                                    "type":"object",
                                                                                                                                    "properties":{
                                                                                                                                        "_link":{
                                                                                                                                            "type":"string",
                                                                                                                                            "description":"_link"
                                                                                                                                        },
                                                                                                                                        "meterId":{
                                                                                                                                            "type":"string",
                                                                                                                                            "maxLength":12,
                                                                                                                                            "description":"Device ID"
                                                                                                                                        }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                "item":{
                                                                                                                                    "type":"object",
                                                                                                                                    "properties":{
                                                                                                                                        "_link":{
                                                                                                                                            "type":"string",
                                                                                                                                            "description":"_link"
                                                                                                                                        },
                                                                                                                                        "itemId":{
                                                                                                                                            "type":"string",
                                                                                                                                            "maxLength":12,
                                                                                                                                            "description":"Device ID"
                                                                                                                                        }
                                                                                                                                    }
                                                                                                                                }
                                                                                                                            }
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                            }
                                                                                                        }
                                                                                                    }
                                                                                                }
                                                                                            }
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1GetVModel"
    }
}

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: ***

{
    "type":"object",
    "description":"Access Group controls which users are allowed to view and update this account's information (including bills, service agreements, payments, and premises).",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accessGroup":{
            "type":"string",
            "maxLength":12,
            "description":"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: object

Show Source

• _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

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"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

{
    "type":"object",
    "description":"Currency Code defines the currency in which the account's financial transactions are expressed",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "currencyId":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        }
    }
}

Nested Schema : customerClass

Type: object

Show Source

• _link: string
  _link
• customerClass: string
  (customerClass)

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "customerClass":{
            "type":"string",
            "description":"(customerClass)"
        }
    }
}

Nested Schema : serviceAgreements

Type: object

Show Source

• serviceAgreementsList: object serviceAgreementsList

{
    "type":"object",
    "properties":{
        "serviceAgreementsList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    }
                                }
                            },
                            "premises":{
                                "type":"object",
                                "properties":{
                                    "premisesList":{
                                        "type":"object",
                                        "properties":{
                                            "_data":{
                                                "type":"array",
                                                "items":{
                                                    "type":"object",
                                                    "properties":{
                                                        "premise":{
                                                            "type":"object",
                                                            "properties":{
                                                                "_link":{
                                                                    "type":"string",
                                                                    "description":"_link"
                                                                },
                                                                "premiseId":{
                                                                    "type":"string",
                                                                    "maxLength":10,
                                                                    "description":"Premise ID"
                                                                },
                                                                "address":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "address1":{
                                                                            "type":"string",
                                                                            "maxLength":254,
                                                                            "description":"The first line of the premise address.",
                                                                            "example":"1 Daily Show"
                                                                        },
                                                                        "address2":{
                                                                            "type":"string",
                                                                            "maxLength":254,
                                                                            "description":"The second line of the premise address.",
                                                                            "example":"ZZRSALDO C2M"
                                                                        },
                                                                        "address3":{
                                                                            "type":"string",
                                                                            "maxLength":254,
                                                                            "description":"The third line of the premise address."
                                                                        },
                                                                        "address4":{
                                                                            "type":"string",
                                                                            "maxLength":254,
                                                                            "description":"The fourth line of the premise address.",
                                                                            "example":"Uniontown"
                                                                        },
                                                                        "city":{
                                                                            "type":"string",
                                                                            "maxLength":90,
                                                                            "description":"The city of the premise address."
                                                                        },
                                                                        "streetNumber1":{
                                                                            "type":"string",
                                                                            "maxLength":6,
                                                                            "description":"The first street number line of the premise address."
                                                                        },
                                                                        "streetNumber2":{
                                                                            "type":"string",
                                                                            "maxLength":4,
                                                                            "description":"The second street number line of the premise address."
                                                                        },
                                                                        "county":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "_link":{
                                                                                    "type":"string",
                                                                                    "description":"_link"
                                                                                },
                                                                                "county":{
                                                                                    "type":"string",
                                                                                    "maxLength":90,
                                                                                    "description":"County"
                                                                                }
                                                                            }
                                                                        },
                                                                        "postal":{
                                                                            "type":"string",
                                                                            "maxLength":12,
                                                                            "description":"The postal code of the premise address.",
                                                                            "example":"44002"
                                                                        },
                                                                        "state":{
                                                                            "type":"string",
                                                                            "maxLength":6,
                                                                            "description":"The state of the premise address.",
                                                                            "example":"OH"
                                                                        },
                                                                        "country":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "_link":{
                                                                                    "type":"string",
                                                                                    "description":"_link"
                                                                                },
                                                                                "country":{
                                                                                    "type":"string",
                                                                                    "maxLength":3,
                                                                                    "description":"Country"
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                },
                                                                "servicePoints":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "servicePointsList":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "_data":{
                                                                                    "type":"array",
                                                                                    "items":{
                                                                                        "type":"object",
                                                                                        "properties":{
                                                                                            "servicePoint":{
                                                                                                "type":"object",
                                                                                                "properties":{
                                                                                                    "_link":{
                                                                                                        "type":"string",
                                                                                                        "description":"_link"
                                                                                                    },
                                                                                                    "servicePointId":{
                                                                                                        "type":"string",
                                                                                                        "maxLength":10,
                                                                                                        "description":"Service Point ID"
                                                                                                    }
                                                                                                }
                                                                                            },
                                                                                            "installEvents":{
                                                                                                "type":"object",
                                                                                                "properties":{
                                                                                                    "installEventsList":{
                                                                                                        "type":"object",
                                                                                                        "properties":{
                                                                                                            "_data":{
                                                                                                                "type":"array",
                                                                                                                "items":{
                                                                                                                    "type":"object",
                                                                                                                    "properties":{
                                                                                                                        "installEvent":{
                                                                                                                            "type":"object",
                                                                                                                            "properties":{
                                                                                                                                "_link":{
                                                                                                                                    "type":"string",
                                                                                                                                    "description":"_link"
                                                                                                                                },
                                                                                                                                "installEventId":{
                                                                                                                                    "type":"string",
                                                                                                                                    "maxLength":12,
                                                                                                                                    "description":"Install Event ID"
                                                                                                                                }
                                                                                                                            }
                                                                                                                        },
                                                                                                                        "deviceType":{
                                                                                                                            "type":"string",
                                                                                                                            "maxLength":30,
                                                                                                                            "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                                                                            "example":"E-SMART-MTR"
                                                                                                                        },
                                                                                                                        "meter":{
                                                                                                                            "type":"object",
                                                                                                                            "properties":{
                                                                                                                                "_link":{
                                                                                                                                    "type":"string",
                                                                                                                                    "description":"_link"
                                                                                                                                },
                                                                                                                                "meterId":{
                                                                                                                                    "type":"string",
                                                                                                                                    "maxLength":12,
                                                                                                                                    "description":"Device ID"
                                                                                                                                }
                                                                                                                            }
                                                                                                                        },
                                                                                                                        "item":{
                                                                                                                            "type":"object",
                                                                                                                            "properties":{
                                                                                                                                "_link":{
                                                                                                                                    "type":"string",
                                                                                                                                    "description":"_link"
                                                                                                                                },
                                                                                                                                "itemId":{
                                                                                                                                    "type":"string",
                                                                                                                                    "maxLength":12,
                                                                                                                                    "description":"Device ID"
                                                                                                                                }
                                                                                                                            }
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                            }
                                                                                                        }
                                                                                                    }
                                                                                                }
                                                                                            }
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : serviceAgreementsList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    },
                    "premises":{
                        "type":"object",
                        "properties":{
                            "premisesList":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "premise":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "premiseId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Premise ID"
                                                        },
                                                        "address":{
                                                            "type":"object",
                                                            "properties":{
                                                                "address1":{
                                                                    "type":"string",
                                                                    "maxLength":254,
                                                                    "description":"The first line of the premise address.",
                                                                    "example":"1 Daily Show"
                                                                },
                                                                "address2":{
                                                                    "type":"string",
                                                                    "maxLength":254,
                                                                    "description":"The second line of the premise address.",
                                                                    "example":"ZZRSALDO C2M"
                                                                },
                                                                "address3":{
                                                                    "type":"string",
                                                                    "maxLength":254,
                                                                    "description":"The third line of the premise address."
                                                                },
                                                                "address4":{
                                                                    "type":"string",
                                                                    "maxLength":254,
                                                                    "description":"The fourth line of the premise address.",
                                                                    "example":"Uniontown"
                                                                },
                                                                "city":{
                                                                    "type":"string",
                                                                    "maxLength":90,
                                                                    "description":"The city of the premise address."
                                                                },
                                                                "streetNumber1":{
                                                                    "type":"string",
                                                                    "maxLength":6,
                                                                    "description":"The first street number line of the premise address."
                                                                },
                                                                "streetNumber2":{
                                                                    "type":"string",
                                                                    "maxLength":4,
                                                                    "description":"The second street number line of the premise address."
                                                                },
                                                                "county":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "_link":{
                                                                            "type":"string",
                                                                            "description":"_link"
                                                                        },
                                                                        "county":{
                                                                            "type":"string",
                                                                            "maxLength":90,
                                                                            "description":"County"
                                                                        }
                                                                    }
                                                                },
                                                                "postal":{
                                                                    "type":"string",
                                                                    "maxLength":12,
                                                                    "description":"The postal code of the premise address.",
                                                                    "example":"44002"
                                                                },
                                                                "state":{
                                                                    "type":"string",
                                                                    "maxLength":6,
                                                                    "description":"The state of the premise address.",
                                                                    "example":"OH"
                                                                },
                                                                "country":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "_link":{
                                                                            "type":"string",
                                                                            "description":"_link"
                                                                        },
                                                                        "country":{
                                                                            "type":"string",
                                                                            "maxLength":3,
                                                                            "description":"Country"
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        "servicePoints":{
                                                            "type":"object",
                                                            "properties":{
                                                                "servicePointsList":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "_data":{
                                                                            "type":"array",
                                                                            "items":{
                                                                                "type":"object",
                                                                                "properties":{
                                                                                    "servicePoint":{
                                                                                        "type":"object",
                                                                                        "properties":{
                                                                                            "_link":{
                                                                                                "type":"string",
                                                                                                "description":"_link"
                                                                                            },
                                                                                            "servicePointId":{
                                                                                                "type":"string",
                                                                                                "maxLength":10,
                                                                                                "description":"Service Point ID"
                                                                                            }
                                                                                        }
                                                                                    },
                                                                                    "installEvents":{
                                                                                        "type":"object",
                                                                                        "properties":{
                                                                                            "installEventsList":{
                                                                                                "type":"object",
                                                                                                "properties":{
                                                                                                    "_data":{
                                                                                                        "type":"array",
                                                                                                        "items":{
                                                                                                            "type":"object",
                                                                                                            "properties":{
                                                                                                                "installEvent":{
                                                                                                                    "type":"object",
                                                                                                                    "properties":{
                                                                                                                        "_link":{
                                                                                                                            "type":"string",
                                                                                                                            "description":"_link"
                                                                                                                        },
                                                                                                                        "installEventId":{
                                                                                                                            "type":"string",
                                                                                                                            "maxLength":12,
                                                                                                                            "description":"Install Event ID"
                                                                                                                        }
                                                                                                                    }
                                                                                                                },
                                                                                                                "deviceType":{
                                                                                                                    "type":"string",
                                                                                                                    "maxLength":30,
                                                                                                                    "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                                                                    "example":"E-SMART-MTR"
                                                                                                                },
                                                                                                                "meter":{
                                                                                                                    "type":"object",
                                                                                                                    "properties":{
                                                                                                                        "_link":{
                                                                                                                            "type":"string",
                                                                                                                            "description":"_link"
                                                                                                                        },
                                                                                                                        "meterId":{
                                                                                                                            "type":"string",
                                                                                                                            "maxLength":12,
                                                                                                                            "description":"Device ID"
                                                                                                                        }
                                                                                                                    }
                                                                                                                },
                                                                                                                "item":{
                                                                                                                    "type":"object",
                                                                                                                    "properties":{
                                                                                                                        "_link":{
                                                                                                                            "type":"string",
                                                                                                                            "description":"_link"
                                                                                                                        },
                                                                                                                        "itemId":{
                                                                                                                            "type":"string",
                                                                                                                            "maxLength":12,
                                                                                                                            "description":"Device ID"
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                            }
                                                                                                        }
                                                                                                    }
                                                                                                }
                                                                                            }
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            },
            "premises":{
                "type":"object",
                "properties":{
                    "premisesList":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "premise":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "premiseId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Premise ID"
                                                },
                                                "address":{
                                                    "type":"object",
                                                    "properties":{
                                                        "address1":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"The first line of the premise address.",
                                                            "example":"1 Daily Show"
                                                        },
                                                        "address2":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"The second line of the premise address.",
                                                            "example":"ZZRSALDO C2M"
                                                        },
                                                        "address3":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"The third line of the premise address."
                                                        },
                                                        "address4":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"The fourth line of the premise address.",
                                                            "example":"Uniontown"
                                                        },
                                                        "city":{
                                                            "type":"string",
                                                            "maxLength":90,
                                                            "description":"The city of the premise address."
                                                        },
                                                        "streetNumber1":{
                                                            "type":"string",
                                                            "maxLength":6,
                                                            "description":"The first street number line of the premise address."
                                                        },
                                                        "streetNumber2":{
                                                            "type":"string",
                                                            "maxLength":4,
                                                            "description":"The second street number line of the premise address."
                                                        },
                                                        "county":{
                                                            "type":"object",
                                                            "properties":{
                                                                "_link":{
                                                                    "type":"string",
                                                                    "description":"_link"
                                                                },
                                                                "county":{
                                                                    "type":"string",
                                                                    "maxLength":90,
                                                                    "description":"County"
                                                                }
                                                            }
                                                        },
                                                        "postal":{
                                                            "type":"string",
                                                            "maxLength":12,
                                                            "description":"The postal code of the premise address.",
                                                            "example":"44002"
                                                        },
                                                        "state":{
                                                            "type":"string",
                                                            "maxLength":6,
                                                            "description":"The state of the premise address.",
                                                            "example":"OH"
                                                        },
                                                        "country":{
                                                            "type":"object",
                                                            "properties":{
                                                                "_link":{
                                                                    "type":"string",
                                                                    "description":"_link"
                                                                },
                                                                "country":{
                                                                    "type":"string",
                                                                    "maxLength":3,
                                                                    "description":"Country"
                                                                }
                                                            }
                                                        }
                                                    }
                                                },
                                                "servicePoints":{
                                                    "type":"object",
                                                    "properties":{
                                                        "servicePointsList":{
                                                            "type":"object",
                                                            "properties":{
                                                                "_data":{
                                                                    "type":"array",
                                                                    "items":{
                                                                        "type":"object",
                                                                        "properties":{
                                                                            "servicePoint":{
                                                                                "type":"object",
                                                                                "properties":{
                                                                                    "_link":{
                                                                                        "type":"string",
                                                                                        "description":"_link"
                                                                                    },
                                                                                    "servicePointId":{
                                                                                        "type":"string",
                                                                                        "maxLength":10,
                                                                                        "description":"Service Point ID"
                                                                                    }
                                                                                }
                                                                            },
                                                                            "installEvents":{
                                                                                "type":"object",
                                                                                "properties":{
                                                                                    "installEventsList":{
                                                                                        "type":"object",
                                                                                        "properties":{
                                                                                            "_data":{
                                                                                                "type":"array",
                                                                                                "items":{
                                                                                                    "type":"object",
                                                                                                    "properties":{
                                                                                                        "installEvent":{
                                                                                                            "type":"object",
                                                                                                            "properties":{
                                                                                                                "_link":{
                                                                                                                    "type":"string",
                                                                                                                    "description":"_link"
                                                                                                                },
                                                                                                                "installEventId":{
                                                                                                                    "type":"string",
                                                                                                                    "maxLength":12,
                                                                                                                    "description":"Install Event ID"
                                                                                                                }
                                                                                                            }
                                                                                                        },
                                                                                                        "deviceType":{
                                                                                                            "type":"string",
                                                                                                            "maxLength":30,
                                                                                                            "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                                                            "example":"E-SMART-MTR"
                                                                                                        },
                                                                                                        "meter":{
                                                                                                            "type":"object",
                                                                                                            "properties":{
                                                                                                                "_link":{
                                                                                                                    "type":"string",
                                                                                                                    "description":"_link"
                                                                                                                },
                                                                                                                "meterId":{
                                                                                                                    "type":"string",
                                                                                                                    "maxLength":12,
                                                                                                                    "description":"Device ID"
                                                                                                                }
                                                                                                            }
                                                                                                        },
                                                                                                        "item":{
                                                                                                            "type":"object",
                                                                                                            "properties":{
                                                                                                                "_link":{
                                                                                                                    "type":"string",
                                                                                                                    "description":"_link"
                                                                                                                },
                                                                                                                "itemId":{
                                                                                                                    "type":"string",
                                                                                                                    "maxLength":12,
                                                                                                                    "description":"Device ID"
                                                                                                                }
                                                                                                            }
                                                                                                        }
                                                                                                    }
                                                                                                }
                                                                                            }
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• premises: object premises
• serviceAgreement: object serviceAgreement

{
    "type":"object",
    "properties":{
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "premises":{
            "type":"object",
            "properties":{
                "premisesList":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "premise":{
                                        "type":"object",
                                        "properties":{
                                            "_link":{
                                                "type":"string",
                                                "description":"_link"
                                            },
                                            "premiseId":{
                                                "type":"string",
                                                "maxLength":10,
                                                "description":"Premise ID"
                                            },
                                            "address":{
                                                "type":"object",
                                                "properties":{
                                                    "address1":{
                                                        "type":"string",
                                                        "maxLength":254,
                                                        "description":"The first line of the premise address.",
                                                        "example":"1 Daily Show"
                                                    },
                                                    "address2":{
                                                        "type":"string",
                                                        "maxLength":254,
                                                        "description":"The second line of the premise address.",
                                                        "example":"ZZRSALDO C2M"
                                                    },
                                                    "address3":{
                                                        "type":"string",
                                                        "maxLength":254,
                                                        "description":"The third line of the premise address."
                                                    },
                                                    "address4":{
                                                        "type":"string",
                                                        "maxLength":254,
                                                        "description":"The fourth line of the premise address.",
                                                        "example":"Uniontown"
                                                    },
                                                    "city":{
                                                        "type":"string",
                                                        "maxLength":90,
                                                        "description":"The city of the premise address."
                                                    },
                                                    "streetNumber1":{
                                                        "type":"string",
                                                        "maxLength":6,
                                                        "description":"The first street number line of the premise address."
                                                    },
                                                    "streetNumber2":{
                                                        "type":"string",
                                                        "maxLength":4,
                                                        "description":"The second street number line of the premise address."
                                                    },
                                                    "county":{
                                                        "type":"object",
                                                        "properties":{
                                                            "_link":{
                                                                "type":"string",
                                                                "description":"_link"
                                                            },
                                                            "county":{
                                                                "type":"string",
                                                                "maxLength":90,
                                                                "description":"County"
                                                            }
                                                        }
                                                    },
                                                    "postal":{
                                                        "type":"string",
                                                        "maxLength":12,
                                                        "description":"The postal code of the premise address.",
                                                        "example":"44002"
                                                    },
                                                    "state":{
                                                        "type":"string",
                                                        "maxLength":6,
                                                        "description":"The state of the premise address.",
                                                        "example":"OH"
                                                    },
                                                    "country":{
                                                        "type":"object",
                                                        "properties":{
                                                            "_link":{
                                                                "type":"string",
                                                                "description":"_link"
                                                            },
                                                            "country":{
                                                                "type":"string",
                                                                "maxLength":3,
                                                                "description":"Country"
                                                            }
                                                        }
                                                    }
                                                }
                                            },
                                            "servicePoints":{
                                                "type":"object",
                                                "properties":{
                                                    "servicePointsList":{
                                                        "type":"object",
                                                        "properties":{
                                                            "_data":{
                                                                "type":"array",
                                                                "items":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "servicePoint":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "_link":{
                                                                                    "type":"string",
                                                                                    "description":"_link"
                                                                                },
                                                                                "servicePointId":{
                                                                                    "type":"string",
                                                                                    "maxLength":10,
                                                                                    "description":"Service Point ID"
                                                                                }
                                                                            }
                                                                        },
                                                                        "installEvents":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "installEventsList":{
                                                                                    "type":"object",
                                                                                    "properties":{
                                                                                        "_data":{
                                                                                            "type":"array",
                                                                                            "items":{
                                                                                                "type":"object",
                                                                                                "properties":{
                                                                                                    "installEvent":{
                                                                                                        "type":"object",
                                                                                                        "properties":{
                                                                                                            "_link":{
                                                                                                                "type":"string",
                                                                                                                "description":"_link"
                                                                                                            },
                                                                                                            "installEventId":{
                                                                                                                "type":"string",
                                                                                                                "maxLength":12,
                                                                                                                "description":"Install Event ID"
                                                                                                            }
                                                                                                        }
                                                                                                    },
                                                                                                    "deviceType":{
                                                                                                        "type":"string",
                                                                                                        "maxLength":30,
                                                                                                        "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                                                        "example":"E-SMART-MTR"
                                                                                                    },
                                                                                                    "meter":{
                                                                                                        "type":"object",
                                                                                                        "properties":{
                                                                                                            "_link":{
                                                                                                                "type":"string",
                                                                                                                "description":"_link"
                                                                                                            },
                                                                                                            "meterId":{
                                                                                                                "type":"string",
                                                                                                                "maxLength":12,
                                                                                                                "description":"Device ID"
                                                                                                            }
                                                                                                        }
                                                                                                    },
                                                                                                    "item":{
                                                                                                        "type":"object",
                                                                                                        "properties":{
                                                                                                            "_link":{
                                                                                                                "type":"string",
                                                                                                                "description":"_link"
                                                                                                            },
                                                                                                            "itemId":{
                                                                                                                "type":"string",
                                                                                                                "maxLength":12,
                                                                                                                "description":"Device ID"
                                                                                                            }
                                                                                                        }
                                                                                                    }
                                                                                                }
                                                                                            }
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : premises

Type: object

Show Source

• premisesList: object premisesList

{
    "type":"object",
    "properties":{
        "premisesList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "premise":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "premiseId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Premise ID"
                                    },
                                    "address":{
                                        "type":"object",
                                        "properties":{
                                            "address1":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"The first line of the premise address.",
                                                "example":"1 Daily Show"
                                            },
                                            "address2":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"The second line of the premise address.",
                                                "example":"ZZRSALDO C2M"
                                            },
                                            "address3":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"The third line of the premise address."
                                            },
                                            "address4":{
                                                "type":"string",
                                                "maxLength":254,
                                                "description":"The fourth line of the premise address.",
                                                "example":"Uniontown"
                                            },
                                            "city":{
                                                "type":"string",
                                                "maxLength":90,
                                                "description":"The city of the premise address."
                                            },
                                            "streetNumber1":{
                                                "type":"string",
                                                "maxLength":6,
                                                "description":"The first street number line of the premise address."
                                            },
                                            "streetNumber2":{
                                                "type":"string",
                                                "maxLength":4,
                                                "description":"The second street number line of the premise address."
                                            },
                                            "county":{
                                                "type":"object",
                                                "properties":{
                                                    "_link":{
                                                        "type":"string",
                                                        "description":"_link"
                                                    },
                                                    "county":{
                                                        "type":"string",
                                                        "maxLength":90,
                                                        "description":"County"
                                                    }
                                                }
                                            },
                                            "postal":{
                                                "type":"string",
                                                "maxLength":12,
                                                "description":"The postal code of the premise address.",
                                                "example":"44002"
                                            },
                                            "state":{
                                                "type":"string",
                                                "maxLength":6,
                                                "description":"The state of the premise address.",
                                                "example":"OH"
                                            },
                                            "country":{
                                                "type":"object",
                                                "properties":{
                                                    "_link":{
                                                        "type":"string",
                                                        "description":"_link"
                                                    },
                                                    "country":{
                                                        "type":"string",
                                                        "maxLength":3,
                                                        "description":"Country"
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "servicePoints":{
                                        "type":"object",
                                        "properties":{
                                            "servicePointsList":{
                                                "type":"object",
                                                "properties":{
                                                    "_data":{
                                                        "type":"array",
                                                        "items":{
                                                            "type":"object",
                                                            "properties":{
                                                                "servicePoint":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "_link":{
                                                                            "type":"string",
                                                                            "description":"_link"
                                                                        },
                                                                        "servicePointId":{
                                                                            "type":"string",
                                                                            "maxLength":10,
                                                                            "description":"Service Point ID"
                                                                        }
                                                                    }
                                                                },
                                                                "installEvents":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "installEventsList":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "_data":{
                                                                                    "type":"array",
                                                                                    "items":{
                                                                                        "type":"object",
                                                                                        "properties":{
                                                                                            "installEvent":{
                                                                                                "type":"object",
                                                                                                "properties":{
                                                                                                    "_link":{
                                                                                                        "type":"string",
                                                                                                        "description":"_link"
                                                                                                    },
                                                                                                    "installEventId":{
                                                                                                        "type":"string",
                                                                                                        "maxLength":12,
                                                                                                        "description":"Install Event ID"
                                                                                                    }
                                                                                                }
                                                                                            },
                                                                                            "deviceType":{
                                                                                                "type":"string",
                                                                                                "maxLength":30,
                                                                                                "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                                                "example":"E-SMART-MTR"
                                                                                            },
                                                                                            "meter":{
                                                                                                "type":"object",
                                                                                                "properties":{
                                                                                                    "_link":{
                                                                                                        "type":"string",
                                                                                                        "description":"_link"
                                                                                                    },
                                                                                                    "meterId":{
                                                                                                        "type":"string",
                                                                                                        "maxLength":12,
                                                                                                        "description":"Device ID"
                                                                                                    }
                                                                                                }
                                                                                            },
                                                                                            "item":{
                                                                                                "type":"object",
                                                                                                "properties":{
                                                                                                    "_link":{
                                                                                                        "type":"string",
                                                                                                        "description":"_link"
                                                                                                    },
                                                                                                    "itemId":{
                                                                                                        "type":"string",
                                                                                                        "maxLength":12,
                                                                                                        "description":"Device ID"
                                                                                                    }
                                                                                                }
                                                                                            }
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• _link: string
  _link
• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Nested Schema : premisesList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "premise":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "premiseId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Premise ID"
                            },
                            "address":{
                                "type":"object",
                                "properties":{
                                    "address1":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"The first line of the premise address.",
                                        "example":"1 Daily Show"
                                    },
                                    "address2":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"The second line of the premise address.",
                                        "example":"ZZRSALDO C2M"
                                    },
                                    "address3":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"The third line of the premise address."
                                    },
                                    "address4":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"The fourth line of the premise address.",
                                        "example":"Uniontown"
                                    },
                                    "city":{
                                        "type":"string",
                                        "maxLength":90,
                                        "description":"The city of the premise address."
                                    },
                                    "streetNumber1":{
                                        "type":"string",
                                        "maxLength":6,
                                        "description":"The first street number line of the premise address."
                                    },
                                    "streetNumber2":{
                                        "type":"string",
                                        "maxLength":4,
                                        "description":"The second street number line of the premise address."
                                    },
                                    "county":{
                                        "type":"object",
                                        "properties":{
                                            "_link":{
                                                "type":"string",
                                                "description":"_link"
                                            },
                                            "county":{
                                                "type":"string",
                                                "maxLength":90,
                                                "description":"County"
                                            }
                                        }
                                    },
                                    "postal":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"The postal code of the premise address.",
                                        "example":"44002"
                                    },
                                    "state":{
                                        "type":"string",
                                        "maxLength":6,
                                        "description":"The state of the premise address.",
                                        "example":"OH"
                                    },
                                    "country":{
                                        "type":"object",
                                        "properties":{
                                            "_link":{
                                                "type":"string",
                                                "description":"_link"
                                            },
                                            "country":{
                                                "type":"string",
                                                "maxLength":3,
                                                "description":"Country"
                                            }
                                        }
                                    }
                                }
                            },
                            "servicePoints":{
                                "type":"object",
                                "properties":{
                                    "servicePointsList":{
                                        "type":"object",
                                        "properties":{
                                            "_data":{
                                                "type":"array",
                                                "items":{
                                                    "type":"object",
                                                    "properties":{
                                                        "servicePoint":{
                                                            "type":"object",
                                                            "properties":{
                                                                "_link":{
                                                                    "type":"string",
                                                                    "description":"_link"
                                                                },
                                                                "servicePointId":{
                                                                    "type":"string",
                                                                    "maxLength":10,
                                                                    "description":"Service Point ID"
                                                                }
                                                            }
                                                        },
                                                        "installEvents":{
                                                            "type":"object",
                                                            "properties":{
                                                                "installEventsList":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "_data":{
                                                                            "type":"array",
                                                                            "items":{
                                                                                "type":"object",
                                                                                "properties":{
                                                                                    "installEvent":{
                                                                                        "type":"object",
                                                                                        "properties":{
                                                                                            "_link":{
                                                                                                "type":"string",
                                                                                                "description":"_link"
                                                                                            },
                                                                                            "installEventId":{
                                                                                                "type":"string",
                                                                                                "maxLength":12,
                                                                                                "description":"Install Event ID"
                                                                                            }
                                                                                        }
                                                                                    },
                                                                                    "deviceType":{
                                                                                        "type":"string",
                                                                                        "maxLength":30,
                                                                                        "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                                        "example":"E-SMART-MTR"
                                                                                    },
                                                                                    "meter":{
                                                                                        "type":"object",
                                                                                        "properties":{
                                                                                            "_link":{
                                                                                                "type":"string",
                                                                                                "description":"_link"
                                                                                            },
                                                                                            "meterId":{
                                                                                                "type":"string",
                                                                                                "maxLength":12,
                                                                                                "description":"Device ID"
                                                                                            }
                                                                                        }
                                                                                    },
                                                                                    "item":{
                                                                                        "type":"object",
                                                                                        "properties":{
                                                                                            "_link":{
                                                                                                "type":"string",
                                                                                                "description":"_link"
                                                                                            },
                                                                                            "itemId":{
                                                                                                "type":"string",
                                                                                                "maxLength":12,
                                                                                                "description":"Device ID"
                                                                                            }
                                                                                        }
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "premise":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Premise ID"
                    },
                    "address":{
                        "type":"object",
                        "properties":{
                            "address1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The first line of the premise address.",
                                "example":"1 Daily Show"
                            },
                            "address2":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The second line of the premise address.",
                                "example":"ZZRSALDO C2M"
                            },
                            "address3":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The third line of the premise address."
                            },
                            "address4":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The fourth line of the premise address.",
                                "example":"Uniontown"
                            },
                            "city":{
                                "type":"string",
                                "maxLength":90,
                                "description":"The city of the premise address."
                            },
                            "streetNumber1":{
                                "type":"string",
                                "maxLength":6,
                                "description":"The first street number line of the premise address."
                            },
                            "streetNumber2":{
                                "type":"string",
                                "maxLength":4,
                                "description":"The second street number line of the premise address."
                            },
                            "county":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "county":{
                                        "type":"string",
                                        "maxLength":90,
                                        "description":"County"
                                    }
                                }
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":12,
                                "description":"The postal code of the premise address.",
                                "example":"44002"
                            },
                            "state":{
                                "type":"string",
                                "maxLength":6,
                                "description":"The state of the premise address.",
                                "example":"OH"
                            },
                            "country":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "country":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Country"
                                    }
                                }
                            }
                        }
                    },
                    "servicePoints":{
                        "type":"object",
                        "properties":{
                            "servicePointsList":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "servicePoint":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "servicePointId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Service Point ID"
                                                        }
                                                    }
                                                },
                                                "installEvents":{
                                                    "type":"object",
                                                    "properties":{
                                                        "installEventsList":{
                                                            "type":"object",
                                                            "properties":{
                                                                "_data":{
                                                                    "type":"array",
                                                                    "items":{
                                                                        "type":"object",
                                                                        "properties":{
                                                                            "installEvent":{
                                                                                "type":"object",
                                                                                "properties":{
                                                                                    "_link":{
                                                                                        "type":"string",
                                                                                        "description":"_link"
                                                                                    },
                                                                                    "installEventId":{
                                                                                        "type":"string",
                                                                                        "maxLength":12,
                                                                                        "description":"Install Event ID"
                                                                                    }
                                                                                }
                                                                            },
                                                                            "deviceType":{
                                                                                "type":"string",
                                                                                "maxLength":30,
                                                                                "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                                "example":"E-SMART-MTR"
                                                                            },
                                                                            "meter":{
                                                                                "type":"object",
                                                                                "properties":{
                                                                                    "_link":{
                                                                                        "type":"string",
                                                                                        "description":"_link"
                                                                                    },
                                                                                    "meterId":{
                                                                                        "type":"string",
                                                                                        "maxLength":12,
                                                                                        "description":"Device ID"
                                                                                    }
                                                                                }
                                                                            },
                                                                            "item":{
                                                                                "type":"object",
                                                                                "properties":{
                                                                                    "_link":{
                                                                                        "type":"string",
                                                                                        "description":"_link"
                                                                                    },
                                                                                    "itemId":{
                                                                                        "type":"string",
                                                                                        "maxLength":12,
                                                                                        "description":"Device ID"
                                                                                    }
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• premise: object premise

{
    "type":"object",
    "properties":{
        "premise":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID"
                },
                "address":{
                    "type":"object",
                    "properties":{
                        "address1":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The first line of the premise address.",
                            "example":"1 Daily Show"
                        },
                        "address2":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The second line of the premise address.",
                            "example":"ZZRSALDO C2M"
                        },
                        "address3":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The third line of the premise address."
                        },
                        "address4":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The fourth line of the premise address.",
                            "example":"Uniontown"
                        },
                        "city":{
                            "type":"string",
                            "maxLength":90,
                            "description":"The city of the premise address."
                        },
                        "streetNumber1":{
                            "type":"string",
                            "maxLength":6,
                            "description":"The first street number line of the premise address."
                        },
                        "streetNumber2":{
                            "type":"string",
                            "maxLength":4,
                            "description":"The second street number line of the premise address."
                        },
                        "county":{
                            "type":"object",
                            "properties":{
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                },
                                "county":{
                                    "type":"string",
                                    "maxLength":90,
                                    "description":"County"
                                }
                            }
                        },
                        "postal":{
                            "type":"string",
                            "maxLength":12,
                            "description":"The postal code of the premise address.",
                            "example":"44002"
                        },
                        "state":{
                            "type":"string",
                            "maxLength":6,
                            "description":"The state of the premise address.",
                            "example":"OH"
                        },
                        "country":{
                            "type":"object",
                            "properties":{
                                "_link":{
                                    "type":"string",
                                    "description":"_link"
                                },
                                "country":{
                                    "type":"string",
                                    "maxLength":3,
                                    "description":"Country"
                                }
                            }
                        }
                    }
                },
                "servicePoints":{
                    "type":"object",
                    "properties":{
                        "servicePointsList":{
                            "type":"object",
                            "properties":{
                                "_data":{
                                    "type":"array",
                                    "items":{
                                        "type":"object",
                                        "properties":{
                                            "servicePoint":{
                                                "type":"object",
                                                "properties":{
                                                    "_link":{
                                                        "type":"string",
                                                        "description":"_link"
                                                    },
                                                    "servicePointId":{
                                                        "type":"string",
                                                        "maxLength":10,
                                                        "description":"Service Point ID"
                                                    }
                                                }
                                            },
                                            "installEvents":{
                                                "type":"object",
                                                "properties":{
                                                    "installEventsList":{
                                                        "type":"object",
                                                        "properties":{
                                                            "_data":{
                                                                "type":"array",
                                                                "items":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "installEvent":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "_link":{
                                                                                    "type":"string",
                                                                                    "description":"_link"
                                                                                },
                                                                                "installEventId":{
                                                                                    "type":"string",
                                                                                    "maxLength":12,
                                                                                    "description":"Install Event ID"
                                                                                }
                                                                            }
                                                                        },
                                                                        "deviceType":{
                                                                            "type":"string",
                                                                            "maxLength":30,
                                                                            "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                            "example":"E-SMART-MTR"
                                                                        },
                                                                        "meter":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "_link":{
                                                                                    "type":"string",
                                                                                    "description":"_link"
                                                                                },
                                                                                "meterId":{
                                                                                    "type":"string",
                                                                                    "maxLength":12,
                                                                                    "description":"Device ID"
                                                                                }
                                                                            }
                                                                        },
                                                                        "item":{
                                                                            "type":"object",
                                                                            "properties":{
                                                                                "_link":{
                                                                                    "type":"string",
                                                                                    "description":"_link"
                                                                                },
                                                                                "itemId":{
                                                                                    "type":"string",
                                                                                    "maxLength":12,
                                                                                    "description":"Device ID"
                                                                                }
                                                                            }
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• address: object address
• premiseId: string
  Maximum Length: 10

  Premise ID
• servicePoints: object servicePoints

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID"
        },
        "address":{
            "type":"object",
            "properties":{
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line of the premise address.",
                    "example":"1 Daily Show"
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line of the premise address.",
                    "example":"ZZRSALDO C2M"
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line of the premise address."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line of the premise address.",
                    "example":"Uniontown"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The city of the premise address."
                },
                "streetNumber1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The first street number line of the premise address."
                },
                "streetNumber2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The second street number line of the premise address."
                },
                "county":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "county":{
                            "type":"string",
                            "maxLength":90,
                            "description":"County"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the premise address.",
                    "example":"44002"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the premise address.",
                    "example":"OH"
                },
                "country":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country"
                        }
                    }
                }
            }
        },
        "servicePoints":{
            "type":"object",
            "properties":{
                "servicePointsList":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "servicePoint":{
                                        "type":"object",
                                        "properties":{
                                            "_link":{
                                                "type":"string",
                                                "description":"_link"
                                            },
                                            "servicePointId":{
                                                "type":"string",
                                                "maxLength":10,
                                                "description":"Service Point ID"
                                            }
                                        }
                                    },
                                    "installEvents":{
                                        "type":"object",
                                        "properties":{
                                            "installEventsList":{
                                                "type":"object",
                                                "properties":{
                                                    "_data":{
                                                        "type":"array",
                                                        "items":{
                                                            "type":"object",
                                                            "properties":{
                                                                "installEvent":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "_link":{
                                                                            "type":"string",
                                                                            "description":"_link"
                                                                        },
                                                                        "installEventId":{
                                                                            "type":"string",
                                                                            "maxLength":12,
                                                                            "description":"Install Event ID"
                                                                        }
                                                                    }
                                                                },
                                                                "deviceType":{
                                                                    "type":"string",
                                                                    "maxLength":30,
                                                                    "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                                    "example":"E-SMART-MTR"
                                                                },
                                                                "meter":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "_link":{
                                                                            "type":"string",
                                                                            "description":"_link"
                                                                        },
                                                                        "meterId":{
                                                                            "type":"string",
                                                                            "maxLength":12,
                                                                            "description":"Device ID"
                                                                        }
                                                                    }
                                                                },
                                                                "item":{
                                                                    "type":"object",
                                                                    "properties":{
                                                                        "_link":{
                                                                            "type":"string",
                                                                            "description":"_link"
                                                                        },
                                                                        "itemId":{
                                                                            "type":"string",
                                                                            "maxLength":12,
                                                                            "description":"Device ID"
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : address

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the premise address.",
            "example":"1 Daily Show"
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line of the premise address.",
            "example":"ZZRSALDO C2M"
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line of the premise address."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line of the premise address.",
            "example":"Uniontown"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the premise address."
        },
        "streetNumber1":{
            "type":"string",
            "maxLength":6,
            "description":"The first street number line of the premise address."
        },
        "streetNumber2":{
            "type":"string",
            "maxLength":4,
            "description":"The second street number line of the premise address."
        },
        "county":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"County"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the premise address.",
            "example":"44002"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the premise address.",
            "example":"OH"
        },
        "country":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                }
            }
        }
    }
}

Nested Schema : servicePoints

Type: object

Show Source

• servicePointsList: object servicePointsList

{
    "type":"object",
    "properties":{
        "servicePointsList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "servicePoint":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "servicePointId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Point ID"
                                    }
                                }
                            },
                            "installEvents":{
                                "type":"object",
                                "properties":{
                                    "installEventsList":{
                                        "type":"object",
                                        "properties":{
                                            "_data":{
                                                "type":"array",
                                                "items":{
                                                    "type":"object",
                                                    "properties":{
                                                        "installEvent":{
                                                            "type":"object",
                                                            "properties":{
                                                                "_link":{
                                                                    "type":"string",
                                                                    "description":"_link"
                                                                },
                                                                "installEventId":{
                                                                    "type":"string",
                                                                    "maxLength":12,
                                                                    "description":"Install Event ID"
                                                                }
                                                            }
                                                        },
                                                        "deviceType":{
                                                            "type":"string",
                                                            "maxLength":30,
                                                            "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                            "example":"E-SMART-MTR"
                                                        },
                                                        "meter":{
                                                            "type":"object",
                                                            "properties":{
                                                                "_link":{
                                                                    "type":"string",
                                                                    "description":"_link"
                                                                },
                                                                "meterId":{
                                                                    "type":"string",
                                                                    "maxLength":12,
                                                                    "description":"Device ID"
                                                                }
                                                            }
                                                        },
                                                        "item":{
                                                            "type":"object",
                                                            "properties":{
                                                                "_link":{
                                                                    "type":"string",
                                                                    "description":"_link"
                                                                },
                                                                "itemId":{
                                                                    "type":"string",
                                                                    "maxLength":12,
                                                                    "description":"Device ID"
                                                                }
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : country

Type: object

Show Source

• _link: string
  _link
• country: string
  Maximum Length: 3

  Country

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        }
    }
}

Nested Schema : county

Type: object

Show Source

• _link: string
  _link
• county: string
  Maximum Length: 90

  County

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"County"
        }
    }
}

Nested Schema : servicePointsList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            }
                        }
                    },
                    "installEvents":{
                        "type":"object",
                        "properties":{
                            "installEventsList":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "installEvent":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "installEventId":{
                                                            "type":"string",
                                                            "maxLength":12,
                                                            "description":"Install Event ID"
                                                        }
                                                    }
                                                },
                                                "deviceType":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                                    "example":"E-SMART-MTR"
                                                },
                                                "meter":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "meterId":{
                                                            "type":"string",
                                                            "maxLength":12,
                                                            "description":"Device ID"
                                                        }
                                                    }
                                                },
                                                "item":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "itemId":{
                                                            "type":"string",
                                                            "maxLength":12,
                                                            "description":"Device ID"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "servicePoint":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    }
                }
            },
            "installEvents":{
                "type":"object",
                "properties":{
                    "installEventsList":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "installEvent":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "installEventId":{
                                                    "type":"string",
                                                    "maxLength":12,
                                                    "description":"Install Event ID"
                                                }
                                            }
                                        },
                                        "deviceType":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                            "example":"E-SMART-MTR"
                                        },
                                        "meter":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "meterId":{
                                                    "type":"string",
                                                    "maxLength":12,
                                                    "description":"Device ID"
                                                }
                                            }
                                        },
                                        "item":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "itemId":{
                                                    "type":"string",
                                                    "maxLength":12,
                                                    "description":"Device ID"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• installEvents: object installEvents
• servicePoint: object servicePoint

{
    "type":"object",
    "properties":{
        "servicePoint":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "servicePointId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Point ID"
                }
            }
        },
        "installEvents":{
            "type":"object",
            "properties":{
                "installEventsList":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "installEvent":{
                                        "type":"object",
                                        "properties":{
                                            "_link":{
                                                "type":"string",
                                                "description":"_link"
                                            },
                                            "installEventId":{
                                                "type":"string",
                                                "maxLength":12,
                                                "description":"Install Event ID"
                                            }
                                        }
                                    },
                                    "deviceType":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                        "example":"E-SMART-MTR"
                                    },
                                    "meter":{
                                        "type":"object",
                                        "properties":{
                                            "_link":{
                                                "type":"string",
                                                "description":"_link"
                                            },
                                            "meterId":{
                                                "type":"string",
                                                "maxLength":12,
                                                "description":"Device ID"
                                            }
                                        }
                                    },
                                    "item":{
                                        "type":"object",
                                        "properties":{
                                            "_link":{
                                                "type":"string",
                                                "description":"_link"
                                            },
                                            "itemId":{
                                                "type":"string",
                                                "maxLength":12,
                                                "description":"Device ID"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : installEvents

Type: object

Show Source

• installEventsList: object installEventsList

{
    "type":"object",
    "properties":{
        "installEventsList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "installEvent":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "installEventId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Install Event ID"
                                    }
                                }
                            },
                            "deviceType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                                "example":"E-SMART-MTR"
                            },
                            "meter":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "meterId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Device ID"
                                    }
                                }
                            },
                            "item":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "itemId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Device ID"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• _link: string
  _link
• servicePointId: string
  Maximum Length: 10

  Service Point ID

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

Nested Schema : installEventsList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "installEvent":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "installEventId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Install Event ID"
                            }
                        }
                    },
                    "deviceType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                        "example":"E-SMART-MTR"
                    },
                    "meter":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "meterId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Device ID"
                            }
                        }
                    },
                    "item":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "itemId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Device ID"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "installEvent":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "installEventId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Install Event ID"
                    }
                }
            },
            "deviceType":{
                "type":"string",
                "maxLength":30,
                "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
                "example":"E-SMART-MTR"
            },
            "meter":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "meterId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Device ID"
                    }
                }
            },
            "item":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "itemId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Device ID"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "installEvent":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "installEventId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Install Event ID"
                }
            }
        },
        "deviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type describes type of device. Typically, devices are categorized into smart meters, manual meters, items, or communications components.",
            "example":"E-SMART-MTR"
        },
        "meter":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "meterId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Device ID"
                }
            }
        },
        "item":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "itemId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Device ID"
                }
            }
        }
    }
}

Nested Schema : installEvent

Type: object

Show Source

• _link: string
  _link
• installEventId: string
  Maximum Length: 12

  Install Event ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "installEventId":{
            "type":"string",
            "maxLength":12,
            "description":"Install Event ID"
        }
    }
}

Nested Schema : item

Type: object

Show Source

• _link: string
  _link
• itemId: string
  Maximum Length: 12

  Device ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "itemId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID"
        }
    }
}

Nested Schema : meter

Type: object

Show Source

• _link: string
  _link
• meterId: string
  Maximum Length: 12

  Device ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "meterId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID"
        }
    }
}

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