Jump to

• Request
• Response

Update Service Point

put

https://server:port/spl/rest/apis/customer/v-model/servicePoints/{servicePointId}

Request

Path Parameters

• servicePointId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accessGroup: string
  Maximum Length: 12

  Access Group
• address: object address
• assetSystemSPId: string
  Maximum Length: 120

  Identifier Value
• characteristicList: object characteristicList
• creationDateTime: string (date-time)
  Create Date/Time
• deviceLocation: string
  Allowed Values: [ "LEFT", "D1-LEFT", "ZZOK1", "GARG", "RIGH" ]

  Device Location: * `LEFT` - Left, * `D1-LEFT` - Left, * `ZZOK1` - OK Test Device Location, * `GARG` - ZZ Garage, * `RIGH` - ZZ - Right
• deviceLocationDetails: string
  Maximum Length: 250

  Device Location Details
• disconnectLocation: string
  Allowed Values: [ "D1DV", "D1SR" ]

  Disconnect Location: * `D1DV` - Device, * `D1SR` - Source
• distributionNetworkFacility: string
  Maximum Length: 14

  Distribution Network Facility
• division: string
  Maximum Length: 30

  Division
• equipments: object equipments
• estimationEligibility: string
  Allowed Values: [ "D1EL", "D1NE" ]

  Estimation Eligibility: * `D1EL` - Eligible, * `D1NE` - Not Eligible
• externalId: string
  Maximum Length: 10

  CCB Service Point ID
• geocodeLatitude: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  Geographic Latitude
• geocodeLongitude: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  Geographic Longitude
• key: string
  Allowed Values: [ "ZZ", "ZZ1", "ZZ2", "false", "true", "ZZ-False", "ZZ-True" ]

  Key: * `ZZ` - ZZ, * `ZZ1` - ZZ1, * `ZZ2` - ZZ2, * `false` - False, * `true` - True, * `ZZ-False` - ZZ-False, * `ZZ-True` - ZZ-True
• keyId: string
  Maximum Length: 30

  Key ID
• lifeSupportSensitiveLoad: string
  Allowed Values: [ "Y ", "ZZLS", "ZZNC", "ZZNL" ]

  Life Support / Sensitive Load: * `Y ` - Yes, * `ZZLS` - On life support, * `ZZNC` - On partial support, * `ZZNL` - Not on life support
• lifeSupportSensitiveLoadDescription: string
  Maximum Length: 4000

  Description
• mainContact: string
  Maximum Length: 12

  Contact ID
• market: object market
• measurementCycle: object measurementCycle
• measurementCycleRoute: string
  Maximum Length: 30

  Route
• measurementCycleRouteSequence: number
  Minimum Value: -999999999

  Maximum Value: 999999999

  Sequence
• multiItems: object multiItems
• okToEnter: string
  Allowed Values: [ "false", "true", "ZZNO" ]

  OK To Enter: * `false` - False, * `true` - True, * `ZZNO` - No
• parentServicePoint: object parentServicePoint
• premise: object premise
• primaryUsId: string
  Maximum Length: 12

  Usage Subscription
• servicePointId: string
  Maximum Length: 12

  Service Point ID
• servicePointType: object servicePointType
• sourceStatus: string
  Allowed Values: [ "D1CN", "D1DC" ]

  Source Status: * `D1CN` - Connected, * `D1DC` - Disconnected
• spInstruction: string
  Allowed Values: [ "ZZ1", "SER", "CHKS", "C", "CON", "S", "ZZZ", "LRC" ]

  SP Instruction: * `ZZ1` - ZZ1, * `SER` - SER Test, * `CHKS` - CHKS Test, * `C` - CON, * `CON` - CON Test, * `S` - SER, * `ZZZ` - ZZZ, * `LRC` - LRC Test
• spInstructionDetails: string
  Maximum Length: 250

  SP Instruction Details
• spWarning: string
  Allowed Values: [ "NEIG", "C", "D", "DIVE", "CAT", "DANG", "DOG" ]

  SP Warning: * `NEIG` - Neig, * `C` - Cat, * `D` - Dog, * `DIVE` - Dive, * `CAT` - Cat, * `DANG` - Dang, * `DOG` - Dog
• status: string
  Maximum Length: 12

  Status
• statusDateTime: string (date-time)
  Status Date/Time
• statusReason: string
  Maximum Length: 30

  Status Reason
• timeZone: object timeZone
  Timezone
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "servicePointId":{
            "type":"string",
            "maxLength":12,
            "description":"Service Point ID"
        },
        "servicePointType":{
            "type":"object",
            "properties":{
                "spType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service Point Type"
                }
            }
        },
        "externalId":{
            "type":"string",
            "maxLength":10,
            "description":"CCB Service Point ID"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status"
        },
        "timeZone":{
            "type":"object",
            "description":"Timezone",
            "properties":{
                "timeZone":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Timezone",
                    "example":"USPACIFIC"
                }
            }
        },
        "market":{
            "type":"object",
            "properties":{
                "market":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Market"
                }
            }
        },
        "parentServicePoint":{
            "type":"object",
            "properties":{
                "parentSPId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Related Service Point"
                }
            }
        },
        "sourceStatus":{
            "type":"string",
            "enum":[
                "D1CN",
                "D1DC"
            ],
            "description":"Source Status:\n* `D1CN` - Connected,\n* `D1DC` - Disconnected"
        },
        "disconnectLocation":{
            "type":"string",
            "enum":[
                "D1DV",
                "D1SR"
            ],
            "description":"Disconnect Location:\n* `D1DV` - Device,\n* `D1SR` - Source"
        },
        "premise":{
            "type":"object",
            "properties":{
                "externalPremiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise"
                }
            }
        },
        "division":{
            "type":"string",
            "maxLength":30,
            "description":"Division"
        },
        "geocodeLatitude":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"Geographic Latitude"
        },
        "geocodeLongitude":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"Geographic Longitude"
        },
        "mainContact":{
            "type":"string",
            "maxLength":12,
            "description":"Contact ID"
        },
        "primaryUsId":{
            "type":"string",
            "maxLength":12,
            "description":"Usage Subscription"
        },
        "assetSystemSPId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "distributionNetworkFacility":{
            "type":"string",
            "maxLength":14,
            "description":"Distribution Network Facility"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"object",
                    "properties":{
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Postal"
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address"
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 2"
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 3"
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 4"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"City"
                },
                "streetNumber1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Number 1"
                },
                "streetNumber2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Number 2"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"County"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"State"
                }
            }
        },
        "estimationEligibility":{
            "type":"string",
            "enum":[
                "D1EL",
                "D1NE"
            ],
            "description":"Estimation Eligibility:\n* `D1EL` - Eligible,\n* `D1NE` - Not Eligible"
        },
        "accessGroup":{
            "type":"string",
            "maxLength":12,
            "description":"Access Group"
        },
        "statusReason":{
            "type":"string",
            "maxLength":30,
            "description":"Status Reason"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time"
        },
        "lifeSupportSensitiveLoad":{
            "type":"string",
            "enum":[
                "Y   ",
                "ZZLS",
                "ZZNC",
                "ZZNL"
            ],
            "description":"Life Support / Sensitive Load:\n* `Y   ` - Yes,\n* `ZZLS` - On life support,\n* `ZZNC` - On partial support,\n* `ZZNL` - Not on life support"
        },
        "lifeSupportSensitiveLoadDescription":{
            "type":"string",
            "maxLength":4000,
            "description":"Description"
        },
        "okToEnter":{
            "type":"string",
            "enum":[
                "false",
                "true",
                "ZZNO"
            ],
            "description":"OK To Enter:\n* `false` - False,\n* `true` - True,\n* `ZZNO` - No"
        },
        "spWarning":{
            "type":"string",
            "enum":[
                "NEIG",
                "C",
                "D",
                "DIVE",
                "CAT",
                "DANG",
                "DOG"
            ],
            "description":"SP Warning:\n* `NEIG` - Neig,\n* `C` - Cat,\n* `D` - Dog,\n* `DIVE` - Dive,\n* `CAT` - Cat,\n* `DANG` - Dang,\n* `DOG` - Dog"
        },
        "spInstruction":{
            "type":"string",
            "enum":[
                "ZZ1",
                "SER",
                "CHKS",
                "C",
                "CON",
                "S",
                "ZZZ",
                "LRC"
            ],
            "description":"SP Instruction:\n* `ZZ1` - ZZ1,\n* `SER` - SER Test,\n* `CHKS` - CHKS Test,\n* `C` - CON,\n* `CON` - CON Test,\n* `S` - SER,\n* `ZZZ` - ZZZ,\n* `LRC` - LRC Test"
        },
        "spInstructionDetails":{
            "type":"string",
            "maxLength":250,
            "description":"SP Instruction Details"
        },
        "key":{
            "type":"string",
            "enum":[
                "ZZ",
                "ZZ1",
                "ZZ2",
                "false",
                "true",
                "ZZ-False",
                "ZZ-True"
            ],
            "description":"Key:\n* `ZZ` - ZZ,\n* `ZZ1` - ZZ1,\n* `ZZ2` - ZZ2,\n* `false` - False,\n* `true` - True,\n* `ZZ-False` - ZZ-False,\n* `ZZ-True` - ZZ-True"
        },
        "keyId":{
            "type":"string",
            "maxLength":30,
            "description":"Key ID"
        },
        "deviceLocation":{
            "type":"string",
            "enum":[
                "LEFT",
                "D1-LEFT",
                "ZZOK1",
                "GARG",
                "RIGH"
            ],
            "description":"Device Location:\n* `LEFT` - Left,\n* `D1-LEFT` - Left,\n* `ZZOK1` - OK Test Device Location,\n* `GARG` - ZZ Garage,\n* `RIGH` - ZZ - Right"
        },
        "deviceLocationDetails":{
            "type":"string",
            "maxLength":250,
            "description":"Device Location Details"
        },
        "measurementCycle":{
            "type":"object",
            "properties":{
                "measurementCycle":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Measurement Cycle"
                }
            }
        },
        "measurementCycleRoute":{
            "type":"string",
            "maxLength":30,
            "description":"Route"
        },
        "measurementCycleRouteSequence":{
            "type":"number",
            "maximum":999999999,
            "minimum":-999999999,
            "description":"Sequence"
        },
        "multiItems":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Start Date/Time"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"End Date/Time"
                            },
                            "installationOverrideQuantity":{
                                "type":"number",
                                "maximum":9.999999999999998E9,
                                "minimum":-9.999999999999998E9,
                                "description":"Installation Override Quantity (Daily)"
                            },
                            "uom":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "sqi":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service Quantity Identifier"
                            },
                            "multiItemCounts":{
                                "type":"object",
                                "properties":{
                                    "multiItemCountList":{
                                        "type":"object",
                                        "properties":{
                                            "_data":{
                                                "type":"array",
                                                "items":{
                                                    "type":"object",
                                                    "properties":{
                                                        "itemType":{
                                                            "type":"string",
                                                            "maxLength":30,
                                                            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                                            "example":"ZZ_DVCTYP_7529"
                                                        },
                                                        "count":{
                                                            "type":"number",
                                                            "maximum":9.9999999999E8,
                                                            "minimum":-9.9999999999E8,
                                                            "description":"Item Count"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "equipments":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "equipment":{
                                "type":"object",
                                "properties":{
                                    "itemId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Equipment ID"
                                    }
                                }
                            },
                            "installDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Installation Date/Time"
                            },
                            "removalDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Removal Date/Time"
                            },
                            "equipmentCount":{
                                "type":"number",
                                "maximum":9.9999999999E8,
                                "minimum":0,
                                "description":"Equipment Count"
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Comments"
                            },
                            "crew":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Crew"
                            }
                        }
                    }
                }
            }
        },
        "characteristicList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
                            },
                            "characteristicValue":{
                                "type":"string",
                                "maxLength":16,
                                "description":"Value of the characteristic as additional data for the record."
                            },
                            "adhocCharacteristicValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "characteristicValueForeignKey":{
                                "type":"object",
                                "properties":{
                                    "characteristicValueForeignKey1":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Characteristic Value FK 1"
                                    }
                                }
                            },
                            "characteristicValueFK2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 2"
                            },
                            "characteristicValueFK3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 3"
                            },
                            "characteristicValueFk4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 4"
                            },
                            "characteristicValueFK5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 5"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1ServicePnt"
    }
}

Nested Schema : address

Type: object

Show Source

• address1: string
  Maximum Length: 254

  Address
• address2: string
  Maximum Length: 254

  Address 2
• address3: string
  Maximum Length: 254

  Address 3
• address4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: object country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• postal: string
  Maximum Length: 12

  Postal
• state: string
  Maximum Length: 6

  State
• streetNumber1: string
  Maximum Length: 6

  Number 1
• streetNumber2: string
  Maximum Length: 4

  Number 2

{
    "type":"object",
    "properties":{
        "country":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"Postal"
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"Address 2"
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"Address 3"
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"Address 4"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"City"
        },
        "streetNumber1":{
            "type":"string",
            "maxLength":6,
            "description":"Number 1"
        },
        "streetNumber2":{
            "type":"string",
            "maxLength":4,
            "description":"Number 2"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"County"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographic":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State"
        }
    }
}

Nested Schema : characteristicList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Value of the characteristic as additional data for the record."
                    },
                    "adhocCharacteristicValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "characteristicValueForeignKey":{
                        "type":"object",
                        "properties":{
                            "characteristicValueForeignKey1":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 1"
                            }
                        }
                    },
                    "characteristicValueFK2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 2"
                    },
                    "characteristicValueFK3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 3"
                    },
                    "characteristicValueFk4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 4"
                    },
                    "characteristicValueFK5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 5"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : equipments

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "equipment":{
                        "type":"object",
                        "properties":{
                            "itemId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Equipment ID"
                            }
                        }
                    },
                    "installDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Installation Date/Time"
                    },
                    "removalDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Removal Date/Time"
                    },
                    "equipmentCount":{
                        "type":"number",
                        "maximum":9.9999999999E8,
                        "minimum":0,
                        "description":"Equipment Count"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Comments"
                    },
                    "crew":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Crew"
                    }
                }
            }
        }
    }
}

Nested Schema : market

Type: object

Show Source

• market: string
  Maximum Length: 30

  Market

{
    "type":"object",
    "properties":{
        "market":{
            "type":"string",
            "maxLength":30,
            "description":"Market"
        }
    }
}

Nested Schema : measurementCycle

Type: object

Show Source

• measurementCycle: string
  Maximum Length: 30

  Measurement Cycle

{
    "type":"object",
    "properties":{
        "measurementCycle":{
            "type":"string",
            "maxLength":30,
            "description":"Measurement Cycle"
        }
    }
}

Nested Schema : multiItems

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start Date/Time"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"End Date/Time"
                    },
                    "installationOverrideQuantity":{
                        "type":"number",
                        "maximum":9.999999999999998E9,
                        "minimum":-9.999999999999998E9,
                        "description":"Installation Override Quantity (Daily)"
                    },
                    "uom":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "sqi":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Quantity Identifier"
                    },
                    "multiItemCounts":{
                        "type":"object",
                        "properties":{
                            "multiItemCountList":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "itemType":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                                    "example":"ZZ_DVCTYP_7529"
                                                },
                                                "count":{
                                                    "type":"number",
                                                    "maximum":9.9999999999E8,
                                                    "minimum":-9.9999999999E8,
                                                    "description":"Item Count"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : parentServicePoint

Type: object

Show Source

• parentSPId: string
  Maximum Length: 12

  Related Service Point

{
    "type":"object",
    "properties":{
        "parentSPId":{
            "type":"string",
            "maxLength":12,
            "description":"Related Service Point"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• externalPremiseId: string
  Maximum Length: 10

  Premise

{
    "type":"object",
    "properties":{
        "externalPremiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise"
        }
    }
}

Nested Schema : servicePointType

Type: object

Show Source

• spType: string
  Maximum Length: 30

  Service Point Type

{
    "type":"object",
    "properties":{
        "spType":{
            "type":"string",
            "maxLength":30,
            "description":"Service Point Type"
        }
    }
}

Nested Schema : timeZone

Type: object

Timezone

Show Source

• timeZone: string
  Maximum Length: 10

  Timezone

  Example: USPACIFIC

{
    "type":"object",
    "description":"Timezone",
    "properties":{
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Timezone",
            "example":"USPACIFIC"
        }
    }
}

Nested Schema : country

Type: object

Show Source

• country: string
  Maximum Length: 3

  Country

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Value of the characteristic as additional data for the record."
            },
            "adhocCharacteristicValue":{
                "type":"string",
                "maxLength":254,
                "description":"Adhoc Characteristic Value"
            },
            "characteristicValueForeignKey":{
                "type":"object",
                "properties":{
                    "characteristicValueForeignKey1":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 1"
                    }
                }
            },
            "characteristicValueFK2":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 2"
            },
            "characteristicValueFK3":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 3"
            },
            "characteristicValueFk4":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 4"
            },
            "characteristicValueFK5":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 5"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• adhocCharacteristicValue: string
  Maximum Length: 254

  Adhoc Characteristic Value
• characteristicType: object characteristicType
• characteristicValue: string
  Maximum Length: 16

  Value of the characteristic as additional data for the record.
• characteristicValueFK2: string
  Maximum Length: 50

  Characteristic Value FK 2
• characteristicValueFK3: string
  Maximum Length: 50

  Characteristic Value FK 3
• characteristicValueFk4: string
  Maximum Length: 50

  Characteristic Value FK 4
• characteristicValueFK5: string
  Maximum Length: 50

  Characteristic Value FK 5
• characteristicValueForeignKey: object characteristicValueForeignKey
• effectiveDate: string (date)
  Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Value of the characteristic as additional data for the record."
        },
        "adhocCharacteristicValue":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "characteristicValueForeignKey":{
            "type":"object",
            "properties":{
                "characteristicValueForeignKey1":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Characteristic Value FK 1"
                }
            }
        },
        "characteristicValueFK2":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 2"
        },
        "characteristicValueFK3":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 3"
        },
        "characteristicValueFk4":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 4"
        },
        "characteristicValueFK5":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 5"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        }
    }
}

Nested Schema : characteristicValueForeignKey

Type: object

Show Source

• characteristicValueForeignKey1: string
  Maximum Length: 50

  Characteristic Value FK 1

{
    "type":"object",
    "properties":{
        "characteristicValueForeignKey1":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 1"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "equipment":{
                "type":"object",
                "properties":{
                    "itemId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Equipment ID"
                    }
                }
            },
            "installDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Installation Date/Time"
            },
            "removalDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Removal Date/Time"
            },
            "equipmentCount":{
                "type":"number",
                "maximum":9.9999999999E8,
                "minimum":0,
                "description":"Equipment Count"
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Comments"
            },
            "crew":{
                "type":"string",
                "maxLength":60,
                "description":"Crew"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Comments
• crew: string
  Maximum Length: 60

  Crew
• equipment: object equipment
• equipmentCount: number
  Minimum Value: 0

  Maximum Value: 9.9999999999E8

  Equipment Count
• installDateTime: string (date-time)
  Installation Date/Time
• removalDateTime: string (date-time)
  Removal Date/Time

{
    "type":"object",
    "properties":{
        "equipment":{
            "type":"object",
            "properties":{
                "itemId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Equipment ID"
                }
            }
        },
        "installDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Installation Date/Time"
        },
        "removalDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Removal Date/Time"
        },
        "equipmentCount":{
            "type":"number",
            "maximum":9.9999999999E8,
            "minimum":0,
            "description":"Equipment Count"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "crew":{
            "type":"string",
            "maxLength":60,
            "description":"Crew"
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• itemId: string
  Maximum Length: 12

  Equipment ID

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Start Date/Time"
            },
            "endDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"End Date/Time"
            },
            "installationOverrideQuantity":{
                "type":"number",
                "maximum":9.999999999999998E9,
                "minimum":-9.999999999999998E9,
                "description":"Installation Override Quantity (Daily)"
            },
            "uom":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "sqi":{
                "type":"string",
                "maxLength":30,
                "description":"Service Quantity Identifier"
            },
            "multiItemCounts":{
                "type":"object",
                "properties":{
                    "multiItemCountList":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "itemType":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                            "example":"ZZ_DVCTYP_7529"
                                        },
                                        "count":{
                                            "type":"number",
                                            "maximum":9.9999999999E8,
                                            "minimum":-9.9999999999E8,
                                            "description":"Item Count"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• endDateTime: string (date-time)
  End Date/Time
• installationOverrideQuantity: number
  Minimum Value: -9.999999999999998E9

  Maximum Value: 9.999999999999998E9

  Installation Override Quantity (Daily)
• multiItemCounts: object multiItemCounts
• sqi: string
  Maximum Length: 30

  Service Quantity Identifier
• startDateTime: string (date-time)
  Start Date/Time
• uom: string
  Maximum Length: 30

  Unit of Measure

{
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Date/Time"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End Date/Time"
        },
        "installationOverrideQuantity":{
            "type":"number",
            "maximum":9.999999999999998E9,
            "minimum":-9.999999999999998E9,
            "description":"Installation Override Quantity (Daily)"
        },
        "uom":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "sqi":{
            "type":"string",
            "maxLength":30,
            "description":"Service Quantity Identifier"
        },
        "multiItemCounts":{
            "type":"object",
            "properties":{
                "multiItemCountList":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "itemType":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                        "example":"ZZ_DVCTYP_7529"
                                    },
                                    "count":{
                                        "type":"number",
                                        "maximum":9.9999999999E8,
                                        "minimum":-9.9999999999E8,
                                        "description":"Item Count"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : multiItemCounts

Type: object

Show Source

• multiItemCountList: object multiItemCountList

{
    "type":"object",
    "properties":{
        "multiItemCountList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "itemType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                "example":"ZZ_DVCTYP_7529"
                            },
                            "count":{
                                "type":"number",
                                "maximum":9.9999999999E8,
                                "minimum":-9.9999999999E8,
                                "description":"Item Count"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : multiItemCountList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "itemType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                        "example":"ZZ_DVCTYP_7529"
                    },
                    "count":{
                        "type":"number",
                        "maximum":9.9999999999E8,
                        "minimum":-9.9999999999E8,
                        "description":"Item Count"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "itemType":{
                "type":"string",
                "maxLength":30,
                "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                "example":"ZZ_DVCTYP_7529"
            },
            "count":{
                "type":"number",
                "maximum":9.9999999999E8,
                "minimum":-9.9999999999E8,
                "description":"Item Count"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• count: number
  Minimum Value: -9.9999999999E8

  Maximum Value: 9.9999999999E8

  Item Count
• itemType: string
  Maximum Length: 30

  Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.

  Example: ZZ_DVCTYP_7529

{
    "type":"object",
    "properties":{
        "itemType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
            "example":"ZZ_DVCTYP_7529"
        },
        "count":{
            "type":"number",
            "maximum":9.9999999999E8,
            "minimum":-9.9999999999E8,
            "description":"Item Count"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accessGroup: string
  Maximum Length: 12

  Access Group
• address: object address
• assetSystemSPId: string
  Maximum Length: 120

  Identifier Value
• characteristicList: object characteristicList
• creationDateTime: string (date-time)
  Create Date/Time
• deviceLocation: string
  Allowed Values: [ "LEFT", "D1-LEFT", "ZZOK1", "GARG", "RIGH" ]

  Device Location: * `LEFT` - Left, * `D1-LEFT` - Left, * `ZZOK1` - OK Test Device Location, * `GARG` - ZZ Garage, * `RIGH` - ZZ - Right
• deviceLocationDetails: string
  Maximum Length: 250

  Device Location Details
• disconnectLocation: string
  Allowed Values: [ "D1DV", "D1SR" ]

  Disconnect Location: * `D1DV` - Device, * `D1SR` - Source
• distributionNetworkFacility: string
  Maximum Length: 14

  Distribution Network Facility
• division: string
  Maximum Length: 30

  Division
• equipments: object equipments
• estimationEligibility: string
  Allowed Values: [ "D1EL", "D1NE" ]

  Estimation Eligibility: * `D1EL` - Eligible, * `D1NE` - Not Eligible
• externalId: string
  Maximum Length: 10

  CCB Service Point ID
• geocodeLatitude: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  Geographic Latitude
• geocodeLongitude: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  Geographic Longitude
• key: string
  Allowed Values: [ "ZZ", "ZZ1", "ZZ2", "false", "true", "ZZ-False", "ZZ-True" ]

  Key: * `ZZ` - ZZ, * `ZZ1` - ZZ1, * `ZZ2` - ZZ2, * `false` - False, * `true` - True, * `ZZ-False` - ZZ-False, * `ZZ-True` - ZZ-True
• keyId: string
  Maximum Length: 30

  Key ID
• lifeSupportSensitiveLoad: string
  Allowed Values: [ "Y ", "ZZLS", "ZZNC", "ZZNL" ]

  Life Support / Sensitive Load: * `Y ` - Yes, * `ZZLS` - On life support, * `ZZNC` - On partial support, * `ZZNL` - Not on life support
• lifeSupportSensitiveLoadDescription: string
  Maximum Length: 4000

  Description
• mainContact: string
  Maximum Length: 12

  Contact ID
• market: object market
• measurementCycle: object measurementCycle
• measurementCycleRoute: string
  Maximum Length: 30

  Route
• measurementCycleRouteSequence: number
  Minimum Value: -999999999

  Maximum Value: 999999999

  Sequence
• multiItems: object multiItems
• okToEnter: string
  Allowed Values: [ "false", "true", "ZZNO" ]

  OK To Enter: * `false` - False, * `true` - True, * `ZZNO` - No
• parentServicePoint: object parentServicePoint
• premise: object premise
• primaryUsId: string
  Maximum Length: 12

  Usage Subscription
• servicePointId: string
  Maximum Length: 12

  Service Point ID
• servicePointType: object servicePointType
• sourceStatus: string
  Allowed Values: [ "D1CN", "D1DC" ]

  Source Status: * `D1CN` - Connected, * `D1DC` - Disconnected
• spInstruction: string
  Allowed Values: [ "ZZ1", "SER", "CHKS", "C", "CON", "S", "ZZZ", "LRC" ]

  SP Instruction: * `ZZ1` - ZZ1, * `SER` - SER Test, * `CHKS` - CHKS Test, * `C` - CON, * `CON` - CON Test, * `S` - SER, * `ZZZ` - ZZZ, * `LRC` - LRC Test
• spInstructionDetails: string
  Maximum Length: 250

  SP Instruction Details
• spWarning: string
  Allowed Values: [ "NEIG", "C", "D", "DIVE", "CAT", "DANG", "DOG" ]

  SP Warning: * `NEIG` - Neig, * `C` - Cat, * `D` - Dog, * `DIVE` - Dive, * `CAT` - Cat, * `DANG` - Dang, * `DOG` - Dog
• status: string
  Maximum Length: 12

  Status
• statusDateTime: string (date-time)
  Status Date/Time
• statusReason: string
  Maximum Length: 30

  Status Reason
• timeZone: object timeZone
  Timezone
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "servicePointId":{
            "type":"string",
            "maxLength":12,
            "description":"Service Point ID"
        },
        "servicePointType":{
            "type":"object",
            "properties":{
                "spType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service Point Type"
                }
            }
        },
        "externalId":{
            "type":"string",
            "maxLength":10,
            "description":"CCB Service Point ID"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status"
        },
        "timeZone":{
            "type":"object",
            "description":"Timezone",
            "properties":{
                "timeZone":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Timezone",
                    "example":"USPACIFIC"
                }
            }
        },
        "market":{
            "type":"object",
            "properties":{
                "market":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Market"
                }
            }
        },
        "parentServicePoint":{
            "type":"object",
            "properties":{
                "parentSPId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Related Service Point"
                }
            }
        },
        "sourceStatus":{
            "type":"string",
            "enum":[
                "D1CN",
                "D1DC"
            ],
            "description":"Source Status:\n* `D1CN` - Connected,\n* `D1DC` - Disconnected"
        },
        "disconnectLocation":{
            "type":"string",
            "enum":[
                "D1DV",
                "D1SR"
            ],
            "description":"Disconnect Location:\n* `D1DV` - Device,\n* `D1SR` - Source"
        },
        "premise":{
            "type":"object",
            "properties":{
                "externalPremiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise"
                }
            }
        },
        "division":{
            "type":"string",
            "maxLength":30,
            "description":"Division"
        },
        "geocodeLatitude":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"Geographic Latitude"
        },
        "geocodeLongitude":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"Geographic Longitude"
        },
        "mainContact":{
            "type":"string",
            "maxLength":12,
            "description":"Contact ID"
        },
        "primaryUsId":{
            "type":"string",
            "maxLength":12,
            "description":"Usage Subscription"
        },
        "assetSystemSPId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "distributionNetworkFacility":{
            "type":"string",
            "maxLength":14,
            "description":"Distribution Network Facility"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"object",
                    "properties":{
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Postal"
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address"
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 2"
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 3"
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 4"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"City"
                },
                "streetNumber1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Number 1"
                },
                "streetNumber2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Number 2"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"County"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"State"
                }
            }
        },
        "estimationEligibility":{
            "type":"string",
            "enum":[
                "D1EL",
                "D1NE"
            ],
            "description":"Estimation Eligibility:\n* `D1EL` - Eligible,\n* `D1NE` - Not Eligible"
        },
        "accessGroup":{
            "type":"string",
            "maxLength":12,
            "description":"Access Group"
        },
        "statusReason":{
            "type":"string",
            "maxLength":30,
            "description":"Status Reason"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time"
        },
        "lifeSupportSensitiveLoad":{
            "type":"string",
            "enum":[
                "Y   ",
                "ZZLS",
                "ZZNC",
                "ZZNL"
            ],
            "description":"Life Support / Sensitive Load:\n* `Y   ` - Yes,\n* `ZZLS` - On life support,\n* `ZZNC` - On partial support,\n* `ZZNL` - Not on life support"
        },
        "lifeSupportSensitiveLoadDescription":{
            "type":"string",
            "maxLength":4000,
            "description":"Description"
        },
        "okToEnter":{
            "type":"string",
            "enum":[
                "false",
                "true",
                "ZZNO"
            ],
            "description":"OK To Enter:\n* `false` - False,\n* `true` - True,\n* `ZZNO` - No"
        },
        "spWarning":{
            "type":"string",
            "enum":[
                "NEIG",
                "C",
                "D",
                "DIVE",
                "CAT",
                "DANG",
                "DOG"
            ],
            "description":"SP Warning:\n* `NEIG` - Neig,\n* `C` - Cat,\n* `D` - Dog,\n* `DIVE` - Dive,\n* `CAT` - Cat,\n* `DANG` - Dang,\n* `DOG` - Dog"
        },
        "spInstruction":{
            "type":"string",
            "enum":[
                "ZZ1",
                "SER",
                "CHKS",
                "C",
                "CON",
                "S",
                "ZZZ",
                "LRC"
            ],
            "description":"SP Instruction:\n* `ZZ1` - ZZ1,\n* `SER` - SER Test,\n* `CHKS` - CHKS Test,\n* `C` - CON,\n* `CON` - CON Test,\n* `S` - SER,\n* `ZZZ` - ZZZ,\n* `LRC` - LRC Test"
        },
        "spInstructionDetails":{
            "type":"string",
            "maxLength":250,
            "description":"SP Instruction Details"
        },
        "key":{
            "type":"string",
            "enum":[
                "ZZ",
                "ZZ1",
                "ZZ2",
                "false",
                "true",
                "ZZ-False",
                "ZZ-True"
            ],
            "description":"Key:\n* `ZZ` - ZZ,\n* `ZZ1` - ZZ1,\n* `ZZ2` - ZZ2,\n* `false` - False,\n* `true` - True,\n* `ZZ-False` - ZZ-False,\n* `ZZ-True` - ZZ-True"
        },
        "keyId":{
            "type":"string",
            "maxLength":30,
            "description":"Key ID"
        },
        "deviceLocation":{
            "type":"string",
            "enum":[
                "LEFT",
                "D1-LEFT",
                "ZZOK1",
                "GARG",
                "RIGH"
            ],
            "description":"Device Location:\n* `LEFT` - Left,\n* `D1-LEFT` - Left,\n* `ZZOK1` - OK Test Device Location,\n* `GARG` - ZZ Garage,\n* `RIGH` - ZZ - Right"
        },
        "deviceLocationDetails":{
            "type":"string",
            "maxLength":250,
            "description":"Device Location Details"
        },
        "measurementCycle":{
            "type":"object",
            "properties":{
                "measurementCycle":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Measurement Cycle"
                }
            }
        },
        "measurementCycleRoute":{
            "type":"string",
            "maxLength":30,
            "description":"Route"
        },
        "measurementCycleRouteSequence":{
            "type":"number",
            "maximum":999999999,
            "minimum":-999999999,
            "description":"Sequence"
        },
        "multiItems":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Start Date/Time"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"End Date/Time"
                            },
                            "installationOverrideQuantity":{
                                "type":"number",
                                "maximum":9.999999999999998E9,
                                "minimum":-9.999999999999998E9,
                                "description":"Installation Override Quantity (Daily)"
                            },
                            "uom":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "sqi":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service Quantity Identifier"
                            },
                            "multiItemCounts":{
                                "type":"object",
                                "properties":{
                                    "multiItemCountList":{
                                        "type":"object",
                                        "properties":{
                                            "_data":{
                                                "type":"array",
                                                "items":{
                                                    "type":"object",
                                                    "properties":{
                                                        "itemType":{
                                                            "type":"string",
                                                            "maxLength":30,
                                                            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                                            "example":"ZZ_DVCTYP_7529"
                                                        },
                                                        "count":{
                                                            "type":"number",
                                                            "maximum":9.9999999999E8,
                                                            "minimum":-9.9999999999E8,
                                                            "description":"Item Count"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "equipments":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "equipment":{
                                "type":"object",
                                "properties":{
                                    "itemId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Equipment ID"
                                    }
                                }
                            },
                            "installDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Installation Date/Time"
                            },
                            "removalDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Removal Date/Time"
                            },
                            "equipmentCount":{
                                "type":"number",
                                "maximum":9.9999999999E8,
                                "minimum":0,
                                "description":"Equipment Count"
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Comments"
                            },
                            "crew":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Crew"
                            }
                        }
                    }
                }
            }
        },
        "characteristicList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
                            },
                            "characteristicValue":{
                                "type":"string",
                                "maxLength":16,
                                "description":"Value of the characteristic as additional data for the record."
                            },
                            "adhocCharacteristicValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "characteristicValueForeignKey":{
                                "type":"object",
                                "properties":{
                                    "characteristicValueForeignKey1":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Characteristic Value FK 1"
                                    }
                                }
                            },
                            "characteristicValueFK2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 2"
                            },
                            "characteristicValueFK3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 3"
                            },
                            "characteristicValueFk4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 4"
                            },
                            "characteristicValueFK5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 5"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1ServicePnt"
    }
}

Nested Schema : address

Type: object

Show Source

• address1: string
  Maximum Length: 254

  Address
• address2: string
  Maximum Length: 254

  Address 2
• address3: string
  Maximum Length: 254

  Address 3
• address4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: object country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• postal: string
  Maximum Length: 12

  Postal
• state: string
  Maximum Length: 6

  State
• streetNumber1: string
  Maximum Length: 6

  Number 1
• streetNumber2: string
  Maximum Length: 4

  Number 2

{
    "type":"object",
    "properties":{
        "country":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"Postal"
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"Address 2"
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"Address 3"
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"Address 4"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"City"
        },
        "streetNumber1":{
            "type":"string",
            "maxLength":6,
            "description":"Number 1"
        },
        "streetNumber2":{
            "type":"string",
            "maxLength":4,
            "description":"Number 2"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"County"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographic":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State"
        }
    }
}

Nested Schema : characteristicList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Value of the characteristic as additional data for the record."
                    },
                    "adhocCharacteristicValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "characteristicValueForeignKey":{
                        "type":"object",
                        "properties":{
                            "characteristicValueForeignKey1":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 1"
                            }
                        }
                    },
                    "characteristicValueFK2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 2"
                    },
                    "characteristicValueFK3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 3"
                    },
                    "characteristicValueFk4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 4"
                    },
                    "characteristicValueFK5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 5"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : equipments

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "equipment":{
                        "type":"object",
                        "properties":{
                            "itemId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Equipment ID"
                            }
                        }
                    },
                    "installDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Installation Date/Time"
                    },
                    "removalDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Removal Date/Time"
                    },
                    "equipmentCount":{
                        "type":"number",
                        "maximum":9.9999999999E8,
                        "minimum":0,
                        "description":"Equipment Count"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Comments"
                    },
                    "crew":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Crew"
                    }
                }
            }
        }
    }
}

Nested Schema : market

Type: object

Show Source

• market: string
  Maximum Length: 30

  Market

{
    "type":"object",
    "properties":{
        "market":{
            "type":"string",
            "maxLength":30,
            "description":"Market"
        }
    }
}

Nested Schema : measurementCycle

Type: object

Show Source

• measurementCycle: string
  Maximum Length: 30

  Measurement Cycle

{
    "type":"object",
    "properties":{
        "measurementCycle":{
            "type":"string",
            "maxLength":30,
            "description":"Measurement Cycle"
        }
    }
}

Nested Schema : multiItems

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start Date/Time"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"End Date/Time"
                    },
                    "installationOverrideQuantity":{
                        "type":"number",
                        "maximum":9.999999999999998E9,
                        "minimum":-9.999999999999998E9,
                        "description":"Installation Override Quantity (Daily)"
                    },
                    "uom":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "sqi":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Quantity Identifier"
                    },
                    "multiItemCounts":{
                        "type":"object",
                        "properties":{
                            "multiItemCountList":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "itemType":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                                    "example":"ZZ_DVCTYP_7529"
                                                },
                                                "count":{
                                                    "type":"number",
                                                    "maximum":9.9999999999E8,
                                                    "minimum":-9.9999999999E8,
                                                    "description":"Item Count"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : parentServicePoint

Type: object

Show Source

• parentSPId: string
  Maximum Length: 12

  Related Service Point

{
    "type":"object",
    "properties":{
        "parentSPId":{
            "type":"string",
            "maxLength":12,
            "description":"Related Service Point"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• externalPremiseId: string
  Maximum Length: 10

  Premise

{
    "type":"object",
    "properties":{
        "externalPremiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise"
        }
    }
}

Nested Schema : servicePointType

Type: object

Show Source

• spType: string
  Maximum Length: 30

  Service Point Type

{
    "type":"object",
    "properties":{
        "spType":{
            "type":"string",
            "maxLength":30,
            "description":"Service Point Type"
        }
    }
}

Nested Schema : timeZone

Type: object

Timezone

Show Source

• timeZone: string
  Maximum Length: 10

  Timezone

  Example: USPACIFIC

{
    "type":"object",
    "description":"Timezone",
    "properties":{
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Timezone",
            "example":"USPACIFIC"
        }
    }
}

Nested Schema : country

Type: object

Show Source

• country: string
  Maximum Length: 3

  Country

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Value of the characteristic as additional data for the record."
            },
            "adhocCharacteristicValue":{
                "type":"string",
                "maxLength":254,
                "description":"Adhoc Characteristic Value"
            },
            "characteristicValueForeignKey":{
                "type":"object",
                "properties":{
                    "characteristicValueForeignKey1":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 1"
                    }
                }
            },
            "characteristicValueFK2":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 2"
            },
            "characteristicValueFK3":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 3"
            },
            "characteristicValueFk4":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 4"
            },
            "characteristicValueFK5":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 5"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• adhocCharacteristicValue: string
  Maximum Length: 254

  Adhoc Characteristic Value
• characteristicType: object characteristicType
• characteristicValue: string
  Maximum Length: 16

  Value of the characteristic as additional data for the record.
• characteristicValueFK2: string
  Maximum Length: 50

  Characteristic Value FK 2
• characteristicValueFK3: string
  Maximum Length: 50

  Characteristic Value FK 3
• characteristicValueFk4: string
  Maximum Length: 50

  Characteristic Value FK 4
• characteristicValueFK5: string
  Maximum Length: 50

  Characteristic Value FK 5
• characteristicValueForeignKey: object characteristicValueForeignKey
• effectiveDate: string (date)
  Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Value of the characteristic as additional data for the record."
        },
        "adhocCharacteristicValue":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "characteristicValueForeignKey":{
            "type":"object",
            "properties":{
                "characteristicValueForeignKey1":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Characteristic Value FK 1"
                }
            }
        },
        "characteristicValueFK2":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 2"
        },
        "characteristicValueFK3":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 3"
        },
        "characteristicValueFk4":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 4"
        },
        "characteristicValueFK5":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 5"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        }
    }
}

Nested Schema : characteristicValueForeignKey

Type: object

Show Source

• characteristicValueForeignKey1: string
  Maximum Length: 50

  Characteristic Value FK 1

{
    "type":"object",
    "properties":{
        "characteristicValueForeignKey1":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 1"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "equipment":{
                "type":"object",
                "properties":{
                    "itemId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Equipment ID"
                    }
                }
            },
            "installDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Installation Date/Time"
            },
            "removalDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Removal Date/Time"
            },
            "equipmentCount":{
                "type":"number",
                "maximum":9.9999999999E8,
                "minimum":0,
                "description":"Equipment Count"
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Comments"
            },
            "crew":{
                "type":"string",
                "maxLength":60,
                "description":"Crew"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Comments
• crew: string
  Maximum Length: 60

  Crew
• equipment: object equipment
• equipmentCount: number
  Minimum Value: 0

  Maximum Value: 9.9999999999E8

  Equipment Count
• installDateTime: string (date-time)
  Installation Date/Time
• removalDateTime: string (date-time)
  Removal Date/Time

{
    "type":"object",
    "properties":{
        "equipment":{
            "type":"object",
            "properties":{
                "itemId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Equipment ID"
                }
            }
        },
        "installDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Installation Date/Time"
        },
        "removalDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Removal Date/Time"
        },
        "equipmentCount":{
            "type":"number",
            "maximum":9.9999999999E8,
            "minimum":0,
            "description":"Equipment Count"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "crew":{
            "type":"string",
            "maxLength":60,
            "description":"Crew"
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• itemId: string
  Maximum Length: 12

  Equipment ID

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Start Date/Time"
            },
            "endDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"End Date/Time"
            },
            "installationOverrideQuantity":{
                "type":"number",
                "maximum":9.999999999999998E9,
                "minimum":-9.999999999999998E9,
                "description":"Installation Override Quantity (Daily)"
            },
            "uom":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "sqi":{
                "type":"string",
                "maxLength":30,
                "description":"Service Quantity Identifier"
            },
            "multiItemCounts":{
                "type":"object",
                "properties":{
                    "multiItemCountList":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "itemType":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                            "example":"ZZ_DVCTYP_7529"
                                        },
                                        "count":{
                                            "type":"number",
                                            "maximum":9.9999999999E8,
                                            "minimum":-9.9999999999E8,
                                            "description":"Item Count"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• endDateTime: string (date-time)
  End Date/Time
• installationOverrideQuantity: number
  Minimum Value: -9.999999999999998E9

  Maximum Value: 9.999999999999998E9

  Installation Override Quantity (Daily)
• multiItemCounts: object multiItemCounts
• sqi: string
  Maximum Length: 30

  Service Quantity Identifier
• startDateTime: string (date-time)
  Start Date/Time
• uom: string
  Maximum Length: 30

  Unit of Measure

{
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Date/Time"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End Date/Time"
        },
        "installationOverrideQuantity":{
            "type":"number",
            "maximum":9.999999999999998E9,
            "minimum":-9.999999999999998E9,
            "description":"Installation Override Quantity (Daily)"
        },
        "uom":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "sqi":{
            "type":"string",
            "maxLength":30,
            "description":"Service Quantity Identifier"
        },
        "multiItemCounts":{
            "type":"object",
            "properties":{
                "multiItemCountList":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "itemType":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                        "example":"ZZ_DVCTYP_7529"
                                    },
                                    "count":{
                                        "type":"number",
                                        "maximum":9.9999999999E8,
                                        "minimum":-9.9999999999E8,
                                        "description":"Item Count"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : multiItemCounts

Type: object

Show Source

• multiItemCountList: object multiItemCountList

{
    "type":"object",
    "properties":{
        "multiItemCountList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "itemType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                "example":"ZZ_DVCTYP_7529"
                            },
                            "count":{
                                "type":"number",
                                "maximum":9.9999999999E8,
                                "minimum":-9.9999999999E8,
                                "description":"Item Count"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : multiItemCountList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "itemType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                        "example":"ZZ_DVCTYP_7529"
                    },
                    "count":{
                        "type":"number",
                        "maximum":9.9999999999E8,
                        "minimum":-9.9999999999E8,
                        "description":"Item Count"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "itemType":{
                "type":"string",
                "maxLength":30,
                "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                "example":"ZZ_DVCTYP_7529"
            },
            "count":{
                "type":"number",
                "maximum":9.9999999999E8,
                "minimum":-9.9999999999E8,
                "description":"Item Count"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• count: number
  Minimum Value: -9.9999999999E8

  Maximum Value: 9.9999999999E8

  Item Count
• itemType: string
  Maximum Length: 30

  Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.

  Example: ZZ_DVCTYP_7529

{
    "type":"object",
    "properties":{
        "itemType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
            "example":"ZZ_DVCTYP_7529"
        },
        "count":{
            "type":"number",
            "maximum":9.9999999999E8,
            "minimum":-9.9999999999E8,
            "description":"Item Count"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1ServicePnt

Type: object

Show Source

• _self: string
  _self
• accessGroup: string
  Maximum Length: 12

  Access Group
• address: object address
• assetSystemSPId: string
  Maximum Length: 120

  Identifier Value
• characteristicList: object characteristicList
• creationDateTime: string (date-time)
  Create Date/Time
• deviceLocation: string
  Allowed Values: [ "LEFT", "D1-LEFT", "ZZOK1", "GARG", "RIGH" ]

  Device Location: * `LEFT` - Left, * `D1-LEFT` - Left, * `ZZOK1` - OK Test Device Location, * `GARG` - ZZ Garage, * `RIGH` - ZZ - Right
• deviceLocationDetails: string
  Maximum Length: 250

  Device Location Details
• disconnectLocation: string
  Allowed Values: [ "D1DV", "D1SR" ]

  Disconnect Location: * `D1DV` - Device, * `D1SR` - Source
• distributionNetworkFacility: string
  Maximum Length: 14

  Distribution Network Facility
• division: string
  Maximum Length: 30

  Division
• equipments: object equipments
• estimationEligibility: string
  Allowed Values: [ "D1EL", "D1NE" ]

  Estimation Eligibility: * `D1EL` - Eligible, * `D1NE` - Not Eligible
• externalId: string
  Maximum Length: 10

  CCB Service Point ID
• geocodeLatitude: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  Geographic Latitude
• geocodeLongitude: number
  Minimum Value: -9.99999999999999E8

  Maximum Value: 9.99999999999999E8

  Geographic Longitude
• key: string
  Allowed Values: [ "ZZ", "ZZ1", "ZZ2", "false", "true", "ZZ-False", "ZZ-True" ]

  Key: * `ZZ` - ZZ, * `ZZ1` - ZZ1, * `ZZ2` - ZZ2, * `false` - False, * `true` - True, * `ZZ-False` - ZZ-False, * `ZZ-True` - ZZ-True
• keyId: string
  Maximum Length: 30

  Key ID
• lifeSupportSensitiveLoad: string
  Allowed Values: [ "Y ", "ZZLS", "ZZNC", "ZZNL" ]

  Life Support / Sensitive Load: * `Y ` - Yes, * `ZZLS` - On life support, * `ZZNC` - On partial support, * `ZZNL` - Not on life support
• lifeSupportSensitiveLoadDescription: string
  Maximum Length: 4000

  Description
• mainContact: string
  Maximum Length: 12

  Contact ID
• market: object market
• measurementCycle: object measurementCycle
• measurementCycleRoute: string
  Maximum Length: 30

  Route
• measurementCycleRouteSequence: number
  Minimum Value: -999999999

  Maximum Value: 999999999

  Sequence
• multiItems: object multiItems
• okToEnter: string
  Allowed Values: [ "false", "true", "ZZNO" ]

  OK To Enter: * `false` - False, * `true` - True, * `ZZNO` - No
• parentServicePoint: object parentServicePoint
• premise: object premise
• primaryUsId: string
  Maximum Length: 12

  Usage Subscription
• servicePointId: string
  Maximum Length: 12

  Service Point ID
• servicePointType: object servicePointType
• sourceStatus: string
  Allowed Values: [ "D1CN", "D1DC" ]

  Source Status: * `D1CN` - Connected, * `D1DC` - Disconnected
• spInstruction: string
  Allowed Values: [ "ZZ1", "SER", "CHKS", "C", "CON", "S", "ZZZ", "LRC" ]

  SP Instruction: * `ZZ1` - ZZ1, * `SER` - SER Test, * `CHKS` - CHKS Test, * `C` - CON, * `CON` - CON Test, * `S` - SER, * `ZZZ` - ZZZ, * `LRC` - LRC Test
• spInstructionDetails: string
  Maximum Length: 250

  SP Instruction Details
• spWarning: string
  Allowed Values: [ "NEIG", "C", "D", "DIVE", "CAT", "DANG", "DOG" ]

  SP Warning: * `NEIG` - Neig, * `C` - Cat, * `D` - Dog, * `DIVE` - Dive, * `CAT` - Cat, * `DANG` - Dang, * `DOG` - Dog
• status: string
  Maximum Length: 12

  Status
• statusDateTime: string (date-time)
  Status Date/Time
• statusReason: string
  Maximum Length: 30

  Status Reason
• timeZone: object timeZone
  Timezone
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":12,
            "description":"Service Point ID"
        },
        "servicePointType":{
            "type":"object",
            "properties":{
                "spType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service Point Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "externalId":{
            "type":"string",
            "maxLength":10,
            "description":"CCB Service Point ID"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status"
        },
        "timeZone":{
            "type":"object",
            "description":"Timezone",
            "properties":{
                "timeZone":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Timezone",
                    "example":"USPACIFIC"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "market":{
            "type":"object",
            "properties":{
                "market":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Market"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "parentServicePoint":{
            "type":"object",
            "properties":{
                "parentSPId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Related Service Point"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "sourceStatus":{
            "type":"string",
            "enum":[
                "D1CN",
                "D1DC"
            ],
            "description":"Source Status:\n* `D1CN` - Connected,\n* `D1DC` - Disconnected"
        },
        "disconnectLocation":{
            "type":"string",
            "enum":[
                "D1DV",
                "D1SR"
            ],
            "description":"Disconnect Location:\n* `D1DV` - Device,\n* `D1SR` - Source"
        },
        "premise":{
            "type":"object",
            "properties":{
                "externalPremiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "division":{
            "type":"string",
            "maxLength":30,
            "description":"Division"
        },
        "geocodeLatitude":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"Geographic Latitude"
        },
        "geocodeLongitude":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":-9.99999999999999E8,
            "description":"Geographic Longitude"
        },
        "mainContact":{
            "type":"string",
            "maxLength":12,
            "description":"Contact ID"
        },
        "primaryUsId":{
            "type":"string",
            "maxLength":12,
            "description":"Usage Subscription"
        },
        "assetSystemSPId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "distributionNetworkFacility":{
            "type":"string",
            "maxLength":14,
            "description":"Distribution Network Facility"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"object",
                    "properties":{
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Country"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Postal"
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address"
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 2"
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 3"
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 4"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"City"
                },
                "streetNumber1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Number 1"
                },
                "streetNumber2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Number 2"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"County"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"State"
                }
            }
        },
        "estimationEligibility":{
            "type":"string",
            "enum":[
                "D1EL",
                "D1NE"
            ],
            "description":"Estimation Eligibility:\n* `D1EL` - Eligible,\n* `D1NE` - Not Eligible"
        },
        "accessGroup":{
            "type":"string",
            "maxLength":12,
            "description":"Access Group"
        },
        "statusReason":{
            "type":"string",
            "maxLength":30,
            "description":"Status Reason"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time"
        },
        "lifeSupportSensitiveLoad":{
            "type":"string",
            "enum":[
                "Y   ",
                "ZZLS",
                "ZZNC",
                "ZZNL"
            ],
            "description":"Life Support / Sensitive Load:\n* `Y   ` - Yes,\n* `ZZLS` - On life support,\n* `ZZNC` - On partial support,\n* `ZZNL` - Not on life support"
        },
        "lifeSupportSensitiveLoadDescription":{
            "type":"string",
            "maxLength":4000,
            "description":"Description"
        },
        "okToEnter":{
            "type":"string",
            "enum":[
                "false",
                "true",
                "ZZNO"
            ],
            "description":"OK To Enter:\n* `false` - False,\n* `true` - True,\n* `ZZNO` - No"
        },
        "spWarning":{
            "type":"string",
            "enum":[
                "NEIG",
                "C",
                "D",
                "DIVE",
                "CAT",
                "DANG",
                "DOG"
            ],
            "description":"SP Warning:\n* `NEIG` - Neig,\n* `C` - Cat,\n* `D` - Dog,\n* `DIVE` - Dive,\n* `CAT` - Cat,\n* `DANG` - Dang,\n* `DOG` - Dog"
        },
        "spInstruction":{
            "type":"string",
            "enum":[
                "ZZ1",
                "SER",
                "CHKS",
                "C",
                "CON",
                "S",
                "ZZZ",
                "LRC"
            ],
            "description":"SP Instruction:\n* `ZZ1` - ZZ1,\n* `SER` - SER Test,\n* `CHKS` - CHKS Test,\n* `C` - CON,\n* `CON` - CON Test,\n* `S` - SER,\n* `ZZZ` - ZZZ,\n* `LRC` - LRC Test"
        },
        "spInstructionDetails":{
            "type":"string",
            "maxLength":250,
            "description":"SP Instruction Details"
        },
        "key":{
            "type":"string",
            "enum":[
                "ZZ",
                "ZZ1",
                "ZZ2",
                "false",
                "true",
                "ZZ-False",
                "ZZ-True"
            ],
            "description":"Key:\n* `ZZ` - ZZ,\n* `ZZ1` - ZZ1,\n* `ZZ2` - ZZ2,\n* `false` - False,\n* `true` - True,\n* `ZZ-False` - ZZ-False,\n* `ZZ-True` - ZZ-True"
        },
        "keyId":{
            "type":"string",
            "maxLength":30,
            "description":"Key ID"
        },
        "deviceLocation":{
            "type":"string",
            "enum":[
                "LEFT",
                "D1-LEFT",
                "ZZOK1",
                "GARG",
                "RIGH"
            ],
            "description":"Device Location:\n* `LEFT` - Left,\n* `D1-LEFT` - Left,\n* `ZZOK1` - OK Test Device Location,\n* `GARG` - ZZ Garage,\n* `RIGH` - ZZ - Right"
        },
        "deviceLocationDetails":{
            "type":"string",
            "maxLength":250,
            "description":"Device Location Details"
        },
        "measurementCycle":{
            "type":"object",
            "properties":{
                "measurementCycle":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Measurement Cycle"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "measurementCycleRoute":{
            "type":"string",
            "maxLength":30,
            "description":"Route"
        },
        "measurementCycleRouteSequence":{
            "type":"number",
            "maximum":999999999,
            "minimum":-999999999,
            "description":"Sequence"
        },
        "multiItems":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Start Date/Time"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"End Date/Time"
                            },
                            "installationOverrideQuantity":{
                                "type":"number",
                                "maximum":9.999999999999998E9,
                                "minimum":-9.999999999999998E9,
                                "description":"Installation Override Quantity (Daily)"
                            },
                            "uom":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            },
                            "sqi":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service Quantity Identifier"
                            },
                            "multiItemCounts":{
                                "type":"object",
                                "properties":{
                                    "multiItemCountList":{
                                        "type":"object",
                                        "properties":{
                                            "_data":{
                                                "type":"array",
                                                "items":{
                                                    "type":"object",
                                                    "properties":{
                                                        "itemType":{
                                                            "type":"string",
                                                            "maxLength":30,
                                                            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                                            "example":"ZZ_DVCTYP_7529"
                                                        },
                                                        "count":{
                                                            "type":"number",
                                                            "maximum":9.9999999999E8,
                                                            "minimum":-9.9999999999E8,
                                                            "description":"Item Count"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "equipments":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "equipment":{
                                "type":"object",
                                "properties":{
                                    "itemId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Equipment ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "installDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Installation Date/Time"
                            },
                            "removalDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Removal Date/Time"
                            },
                            "equipmentCount":{
                                "type":"number",
                                "maximum":9.9999999999E8,
                                "minimum":0,
                                "description":"Equipment Count"
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Comments"
                            },
                            "crew":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Crew"
                            }
                        }
                    }
                }
            }
        },
        "characteristicList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
                            },
                            "characteristicValue":{
                                "type":"string",
                                "maxLength":16,
                                "description":"Value of the characteristic as additional data for the record."
                            },
                            "adhocCharacteristicValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "characteristicValueForeignKey":{
                                "type":"object",
                                "properties":{
                                    "characteristicValueForeignKey1":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Characteristic Value FK 1"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "characteristicValueFK2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 2"
                            },
                            "characteristicValueFK3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 3"
                            },
                            "characteristicValueFk4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 4"
                            },
                            "characteristicValueFK5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 5"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1ServicePnt"
    }
}

Nested Schema : address

Type: object

Show Source

• address1: string
  Maximum Length: 254

  Address
• address2: string
  Maximum Length: 254

  Address 2
• address3: string
  Maximum Length: 254

  Address 3
• address4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: object country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• postal: string
  Maximum Length: 12

  Postal
• state: string
  Maximum Length: 6

  State
• streetNumber1: string
  Maximum Length: 6

  Number 1
• streetNumber2: string
  Maximum Length: 4

  Number 2

{
    "type":"object",
    "properties":{
        "country":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"Postal"
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"Address 2"
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"Address 3"
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"Address 4"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"City"
        },
        "streetNumber1":{
            "type":"string",
            "maxLength":6,
            "description":"Number 1"
        },
        "streetNumber2":{
            "type":"string",
            "maxLength":4,
            "description":"Number 2"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"County"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographic":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State"
        }
    }
}

Nested Schema : characteristicList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
                    },
                    "characteristicValue":{
                        "type":"string",
                        "maxLength":16,
                        "description":"Value of the characteristic as additional data for the record."
                    },
                    "adhocCharacteristicValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "characteristicValueForeignKey":{
                        "type":"object",
                        "properties":{
                            "characteristicValueForeignKey1":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 1"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "characteristicValueFK2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 2"
                    },
                    "characteristicValueFK3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 3"
                    },
                    "characteristicValueFk4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 4"
                    },
                    "characteristicValueFK5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 5"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : equipments

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "equipment":{
                        "type":"object",
                        "properties":{
                            "itemId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Equipment ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "installDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Installation Date/Time"
                    },
                    "removalDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Removal Date/Time"
                    },
                    "equipmentCount":{
                        "type":"number",
                        "maximum":9.9999999999E8,
                        "minimum":0,
                        "description":"Equipment Count"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Comments"
                    },
                    "crew":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Crew"
                    }
                }
            }
        }
    }
}

Nested Schema : market

Type: object

Show Source

• _link: string
  _link
• market: string
  Maximum Length: 30

  Market

{
    "type":"object",
    "properties":{
        "market":{
            "type":"string",
            "maxLength":30,
            "description":"Market"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : measurementCycle

Type: object

Show Source

• _link: string
  _link
• measurementCycle: string
  Maximum Length: 30

  Measurement Cycle

{
    "type":"object",
    "properties":{
        "measurementCycle":{
            "type":"string",
            "maxLength":30,
            "description":"Measurement Cycle"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : multiItems

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start Date/Time"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"End Date/Time"
                    },
                    "installationOverrideQuantity":{
                        "type":"number",
                        "maximum":9.999999999999998E9,
                        "minimum":-9.999999999999998E9,
                        "description":"Installation Override Quantity (Daily)"
                    },
                    "uom":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    },
                    "sqi":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Quantity Identifier"
                    },
                    "multiItemCounts":{
                        "type":"object",
                        "properties":{
                            "multiItemCountList":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "itemType":{
                                                    "type":"string",
                                                    "maxLength":30,
                                                    "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                                    "example":"ZZ_DVCTYP_7529"
                                                },
                                                "count":{
                                                    "type":"number",
                                                    "maximum":9.9999999999E8,
                                                    "minimum":-9.9999999999E8,
                                                    "description":"Item Count"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : parentServicePoint

Type: object

Show Source

• _link: string
  _link
• parentSPId: string
  Maximum Length: 12

  Related Service Point

{
    "type":"object",
    "properties":{
        "parentSPId":{
            "type":"string",
            "maxLength":12,
            "description":"Related Service Point"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• externalPremiseId: string
  Maximum Length: 10

  Premise

{
    "type":"object",
    "properties":{
        "externalPremiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : servicePointType

Type: object

Show Source

• _link: string
  _link
• spType: string
  Maximum Length: 30

  Service Point Type

{
    "type":"object",
    "properties":{
        "spType":{
            "type":"string",
            "maxLength":30,
            "description":"Service Point Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : timeZone

Type: object

Timezone

Show Source

• _link: string
  _link
• timeZone: string
  Maximum Length: 10

  Timezone

  Example: USPACIFIC

{
    "type":"object",
    "description":"Timezone",
    "properties":{
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Timezone",
            "example":"USPACIFIC"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : country

Type: object

Show Source

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

  Country

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
            },
            "characteristicValue":{
                "type":"string",
                "maxLength":16,
                "description":"Value of the characteristic as additional data for the record."
            },
            "adhocCharacteristicValue":{
                "type":"string",
                "maxLength":254,
                "description":"Adhoc Characteristic Value"
            },
            "characteristicValueForeignKey":{
                "type":"object",
                "properties":{
                    "characteristicValueForeignKey1":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 1"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "characteristicValueFK2":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 2"
            },
            "characteristicValueFK3":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 3"
            },
            "characteristicValueFk4":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 4"
            },
            "characteristicValueFK5":{
                "type":"string",
                "maxLength":50,
                "description":"Characteristic Value FK 5"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• adhocCharacteristicValue: string
  Maximum Length: 254

  Adhoc Characteristic Value
• characteristicType: object characteristicType
• characteristicValue: string
  Maximum Length: 16

  Value of the characteristic as additional data for the record.
• characteristicValueFK2: string
  Maximum Length: 50

  Characteristic Value FK 2
• characteristicValueFK3: string
  Maximum Length: 50

  Characteristic Value FK 3
• characteristicValueFk4: string
  Maximum Length: 50

  Characteristic Value FK 4
• characteristicValueFK5: string
  Maximum Length: 50

  Characteristic Value FK 5
• characteristicValueForeignKey: object characteristicValueForeignKey
• effectiveDate: string (date)
  Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date Indicate the effective date of the characteristic type and value. The service point's install date defaults."
        },
        "characteristicValue":{
            "type":"string",
            "maxLength":16,
            "description":"Value of the characteristic as additional data for the record."
        },
        "adhocCharacteristicValue":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "characteristicValueForeignKey":{
            "type":"object",
            "properties":{
                "characteristicValueForeignKey1":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Characteristic Value FK 1"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "characteristicValueFK2":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 2"
        },
        "characteristicValueFK3":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 3"
        },
        "characteristicValueFk4":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 4"
        },
        "characteristicValueFK5":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 5"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• _link: string
  _link
• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : characteristicValueForeignKey

Type: object

Show Source

• _link: string
  _link
• characteristicValueForeignKey1: string
  Maximum Length: 50

  Characteristic Value FK 1

{
    "type":"object",
    "properties":{
        "characteristicValueForeignKey1":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 1"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "equipment":{
                "type":"object",
                "properties":{
                    "itemId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Equipment ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "installDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Installation Date/Time"
            },
            "removalDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Removal Date/Time"
            },
            "equipmentCount":{
                "type":"number",
                "maximum":9.9999999999E8,
                "minimum":0,
                "description":"Equipment Count"
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Comments"
            },
            "crew":{
                "type":"string",
                "maxLength":60,
                "description":"Crew"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Comments
• crew: string
  Maximum Length: 60

  Crew
• equipment: object equipment
• equipmentCount: number
  Minimum Value: 0

  Maximum Value: 9.9999999999E8

  Equipment Count
• installDateTime: string (date-time)
  Installation Date/Time
• removalDateTime: string (date-time)
  Removal Date/Time

{
    "type":"object",
    "properties":{
        "equipment":{
            "type":"object",
            "properties":{
                "itemId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Equipment ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "installDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Installation Date/Time"
        },
        "removalDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Removal Date/Time"
        },
        "equipmentCount":{
            "type":"number",
            "maximum":9.9999999999E8,
            "minimum":0,
            "description":"Equipment Count"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "crew":{
            "type":"string",
            "maxLength":60,
            "description":"Crew"
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

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

  Equipment ID

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Start Date/Time"
            },
            "endDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"End Date/Time"
            },
            "installationOverrideQuantity":{
                "type":"number",
                "maximum":9.999999999999998E9,
                "minimum":-9.999999999999998E9,
                "description":"Installation Override Quantity (Daily)"
            },
            "uom":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure"
            },
            "sqi":{
                "type":"string",
                "maxLength":30,
                "description":"Service Quantity Identifier"
            },
            "multiItemCounts":{
                "type":"object",
                "properties":{
                    "multiItemCountList":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "itemType":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                            "example":"ZZ_DVCTYP_7529"
                                        },
                                        "count":{
                                            "type":"number",
                                            "maximum":9.9999999999E8,
                                            "minimum":-9.9999999999E8,
                                            "description":"Item Count"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• endDateTime: string (date-time)
  End Date/Time
• installationOverrideQuantity: number
  Minimum Value: -9.999999999999998E9

  Maximum Value: 9.999999999999998E9

  Installation Override Quantity (Daily)
• multiItemCounts: object multiItemCounts
• sqi: string
  Maximum Length: 30

  Service Quantity Identifier
• startDateTime: string (date-time)
  Start Date/Time
• uom: string
  Maximum Length: 30

  Unit of Measure

{
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start Date/Time"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End Date/Time"
        },
        "installationOverrideQuantity":{
            "type":"number",
            "maximum":9.999999999999998E9,
            "minimum":-9.999999999999998E9,
            "description":"Installation Override Quantity (Daily)"
        },
        "uom":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        },
        "sqi":{
            "type":"string",
            "maxLength":30,
            "description":"Service Quantity Identifier"
        },
        "multiItemCounts":{
            "type":"object",
            "properties":{
                "multiItemCountList":{
                    "type":"object",
                    "properties":{
                        "_data":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "itemType":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                        "example":"ZZ_DVCTYP_7529"
                                    },
                                    "count":{
                                        "type":"number",
                                        "maximum":9.9999999999E8,
                                        "minimum":-9.9999999999E8,
                                        "description":"Item Count"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : multiItemCounts

Type: object

Show Source

• multiItemCountList: object multiItemCountList

{
    "type":"object",
    "properties":{
        "multiItemCountList":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "itemType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                                "example":"ZZ_DVCTYP_7529"
                            },
                            "count":{
                                "type":"number",
                                "maximum":9.9999999999E8,
                                "minimum":-9.9999999999E8,
                                "description":"Item Count"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : multiItemCountList

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "itemType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                        "example":"ZZ_DVCTYP_7529"
                    },
                    "count":{
                        "type":"number",
                        "maximum":9.9999999999E8,
                        "minimum":-9.9999999999E8,
                        "description":"Item Count"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "itemType":{
                "type":"string",
                "maxLength":30,
                "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
                "example":"ZZ_DVCTYP_7529"
            },
            "count":{
                "type":"number",
                "maximum":9.9999999999E8,
                "minimum":-9.9999999999E8,
                "description":"Item Count"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• count: number
  Minimum Value: -9.9999999999E8

  Maximum Value: 9.9999999999E8

  Item Count
• itemType: string
  Maximum Length: 30

  Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.

  Example: ZZ_DVCTYP_7529

{
    "type":"object",
    "properties":{
        "itemType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type indicates the type of device. Typically, devices are categorised into smart meters, manual meters, items, or communications components. The code used to denote the device type will vary by utility.",
            "example":"ZZ_DVCTYP_7529"
        },
        "count":{
            "type":"number",
            "maximum":9.9999999999E8,
            "minimum":-9.9999999999E8,
            "description":"Item Count"
        }
    }
}

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