Jump to

• Request
• Response

Update Usage Subscription

put

/rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}

Request

Path Parameters

• usageSubscriptionId(required): string
  Usage Subscription ID is a system assigned random number that stays with a usage subscription record.

  Example:

  543722442966

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
• comments: string
  Maximum Length: 254

  Comments
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2015-12-18T16:08:26-08:00
• division: string
  Maximum Length: 30

  Divisions are used to delineate between different operating companies within a large conglomerate of utilities.

  Example: CA
• dynamicOptions: object dynamicOptions
• endDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.
• externalAccountId: string
  Maximum Length: 30

  ID used in an external application identify the usage subscription.

  Example: 22132634-15-KMUS
• externalId: string
  Maximum Length: 60

  ID used in an external application identify the usage subscription.

  Example: 22132634-01-KMUS
• factorOverrides: object factorOverrides
• fallbackUsageCalculationGroups: object fallbackUsageCalculationGroups
• mainContact: object mainContact
• masterUsageSubscription: string
  Maximum Length: 12

  "Master" and "sub" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service).
• measuringComponents: object measuringComponents
• mostRecentUsageTransactionDateTime: string (date-time)
  Most Recent Transaction Date/Time
• rateHistory: object rateHistory
• servicePoints: object servicePoints
• startDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.

  Example: 2014-01-01T00:00:00-08:00
• status: string
  Maximum Length: 12

  The current status of usage subscription.

  Example: Active
• statusDateTime: string (date-time)
  Status Date/Time

  Example: 2015-12-18T16:08:26-08:00
• timeZone: string
  Maximum Length: 10

  The time zone in which the usage subscription is active.

  Example: USPACIFIC
• usageApprovalRequired: string
  Allowed Values: [ "D1NR", "D1RQ" ]

  A flag that indicates if usage must be approved before being sent to the recipient. * `D1NR` - Not Required, * `D1RQ` - Required

  Example: D1NR
• usageCalculationGroups: object usageCalculationGroups
• usageRecipient: string
  Maximum Length: 30

  The service provider is used as the identity of the subscribing system.
• usageSubscriptionId: string
  Maximum Length: 12

  Usage Subscription ID is a system assigned random number that stays with a usage subscription record.

  Example: 543722442966
• usageSubscriptionMarketParticipant: string
  Maximum Length: 12

  Defines the Usage Subscription Market Participant associated with the child Usage Subscription.
• usageSubscriptionType: object usageSubscriptionType
  Type of Usage Subscription
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks

  Example: 5

{
    "type":"object",
    "properties":{
        "usageSubscriptionId":{
            "type":"string",
            "maxLength":12,
            "description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.",
            "example":"543722442966"
        },
        "usageSubscriptionType":{
            "type":"object",
            "description":"Type of Usage Subscription",
            "properties":{
                "usageSubscriptionType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Type of Usage Subscription",
                    "example":"E-RESAOH"
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"The current status of usage subscription.",
            "example":"Active"
        },
        "masterUsageSubscription":{
            "type":"string",
            "maxLength":12,
            "description":"\"Master\" and \"sub\" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service)."
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2015-12-18T16:08:26-08:00"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2015-12-18T16:08:26-08:00"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active."
        },
        "division":{
            "type":"string",
            "maxLength":30,
            "description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.",
            "example":"CA"
        },
        "accessGroup":{
            "type":"string",
            "maxLength":12,
            "description":"Access Group"
        },
        "mostRecentUsageTransactionDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Most Recent Transaction Date/Time"
        },
        "usageRecipient":{
            "type":"string",
            "maxLength":30,
            "description":"The service provider is used as the identity of the subscribing system."
        },
        "usageApprovalRequired":{
            "type":"string",
            "enum":[
                "D1NR",
                "D1RQ"
            ],
            "description":"A flag that indicates if usage must be approved before being sent to the recipient.\n* `D1NR` - Not Required,\n* `D1RQ` - Required",
            "example":"D1NR"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"ID used in an external application identify the usage subscription.",
            "example":"22132634-01-KMUS"
        },
        "externalAccountId":{
            "type":"string",
            "maxLength":30,
            "description":"ID used in an external application identify the usage subscription.",
            "example":"22132634-15-KMUS"
        },
        "mainContact":{
            "type":"object",
            "properties":{
                "mainContactId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The main contact for the usage subscription.",
                    "example":"003007788788"
                }
            }
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"The time zone in which the usage subscription is active.",
            "example":"USPACIFIC"
        },
        "usageSubscriptionMarketParticipant":{
            "type":"string",
            "maxLength":12,
            "description":"Defines the Usage Subscription Market Participant associated with the child Usage Subscription."
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks",
            "example":"5"
        },
        "servicePoints":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "servicePoint":{
                                "type":"object",
                                "properties":{
                                    "spId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Service Point ID"
                                    }
                                }
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start and end times that define the time period during which the usage subscription is active.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "overrideStartDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
                            },
                            "stopDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
                            },
                            "overrideStopDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
                            },
                            "usage":{
                                "type":"string",
                                "enum":[
                                    "D1AD",
                                    "D1CK",
                                    "D1ST"
                                ],
                                "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
                                "example":"D1AD"
                            },
                            "usePercent":{
                                "type":"number",
                                "maximum":999.99,
                                "minimum":-999.99,
                                "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
                                "example":"100"
                            }
                        }
                    }
                }
            }
        },
        "factorOverrides":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "factor":{
                                "type":"object",
                                "properties":{
                                    "factor":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Factor"
                                    }
                                }
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start and end times that define the time period during which the usage subscription is active.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start and end times that define the time period during which the usage subscription is active."
                            },
                            "value":{
                                "type":"number",
                                "maximum":1.0E11,
                                "minimum":-1.0E11,
                                "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
                                "example":"20"
                            }
                        }
                    }
                }
            }
        },
        "usageCalculationGroups":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "calculationGroup":{
                                "type":"object",
                                "properties":{
                                    "usageGroup":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Calculation Group"
                                    }
                                }
                            },
                            "effectiveDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Effective Date/Time for calculation groups.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "expirationDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Expiration date and time for calculation groups.",
                                "example":"2011-02-10T00:00:00-08:00"
                            }
                        }
                    }
                }
            }
        },
        "fallbackUsageCalculationGroups":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "calculationGroup":{
                                "type":"object",
                                "properties":{
                                    "calculationGroup":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Calculation Group"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "rateHistory":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "rate":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Rate"
                            }
                        }
                    }
                }
            }
        },
        "measuringComponents":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "relationshipType":{
                                "type":"string",
                                "enum":[
                                    "D2CA",
                                    "D2SR",
                                    "ZZAA",
                                    "ZZBR",
                                    "ZZM1",
                                    "ZZM2",
                                    "ZZM3",
                                    "ZZM4",
                                    "ZZM5",
                                    "ZZS1",
                                    "ZZS2",
                                    "ZZSE",
                                    "ZZSI",
                                    "ZZSM",
                                    "ZZZL"
                                ],
                                "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
                                "example":"D2CA"
                            },
                            "measuringComponent":{
                                "type":"object",
                                "properties":{
                                    "measuringComponentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Measuring Component ID"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "dynamicOptions":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "dynamicOption":{
                                "type":"object",
                                "properties":{
                                    "dynamicOptionId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Dynamic Option ID"
                                    }
                                }
                            },
                            "effectiveDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Effective Date/Time for calculation groups.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "expirationDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Expiration date and time for calculation groups.",
                                "example":"2011-02-10T00:00:00-08:00"
                            },
                            "dynamicOptionOverrides":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "dynamicOptionEvent":{
                                                    "type":"object",
                                                    "properties":{
                                                        "dynamicOptionEventId":{
                                                            "type":"string",
                                                            "maxLength":14,
                                                            "description":"Dynamic Option Event ID"
                                                        }
                                                    }
                                                },
                                                "overrideDateTime":{
                                                    "type":"string",
                                                    "format":"date-time",
                                                    "description":"Override Date/Time for dynamic option overrides.",
                                                    "example":"2014-01-01T00:00:00-08:00"
                                                },
                                                "status":{
                                                    "type":"string",
                                                    "enum":[
                                                        "D1AC",
                                                        "D1IN"
                                                    ],
                                                    "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                                    "example":"D1AC"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-UsageSubs"
    }
}

Nested Schema : dynamicOptions

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dynamicOption":{
                        "type":"object",
                        "properties":{
                            "dynamicOptionId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Dynamic Option ID"
                            }
                        }
                    },
                    "effectiveDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Effective Date/Time for calculation groups.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "expirationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Expiration date and time for calculation groups.",
                        "example":"2011-02-10T00:00:00-08:00"
                    },
                    "dynamicOptionOverrides":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "dynamicOptionEvent":{
                                            "type":"object",
                                            "properties":{
                                                "dynamicOptionEventId":{
                                                    "type":"string",
                                                    "maxLength":14,
                                                    "description":"Dynamic Option Event ID"
                                                }
                                            }
                                        },
                                        "overrideDateTime":{
                                            "type":"string",
                                            "format":"date-time",
                                            "description":"Override Date/Time for dynamic option overrides.",
                                            "example":"2014-01-01T00:00:00-08:00"
                                        },
                                        "status":{
                                            "type":"string",
                                            "enum":[
                                                "D1AC",
                                                "D1IN"
                                            ],
                                            "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                            "example":"D1AC"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : factorOverrides

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "factor":{
                        "type":"object",
                        "properties":{
                            "factor":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Factor"
                            }
                        }
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start and end times that define the time period during which the usage subscription is active.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start and end times that define the time period during which the usage subscription is active."
                    },
                    "value":{
                        "type":"number",
                        "maximum":1.0E11,
                        "minimum":-1.0E11,
                        "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
                        "example":"20"
                    }
                }
            }
        }
    }
}

Nested Schema : fallbackUsageCalculationGroups

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "calculationGroup":{
                        "type":"object",
                        "properties":{
                            "calculationGroup":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Calculation Group"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : mainContact

Type: object

Show Source

• mainContactId: string
  Maximum Length: 12

  The main contact for the usage subscription.

  Example: 003007788788

{
    "type":"object",
    "properties":{
        "mainContactId":{
            "type":"string",
            "maxLength":12,
            "description":"The main contact for the usage subscription.",
            "example":"003007788788"
        }
    }
}

Nested Schema : measuringComponents

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "relationshipType":{
                        "type":"string",
                        "enum":[
                            "D2CA",
                            "D2SR",
                            "ZZAA",
                            "ZZBR",
                            "ZZM1",
                            "ZZM2",
                            "ZZM3",
                            "ZZM4",
                            "ZZM5",
                            "ZZS1",
                            "ZZS2",
                            "ZZSE",
                            "ZZSI",
                            "ZZSM",
                            "ZZZL"
                        ],
                        "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
                        "example":"D2CA"
                    },
                    "measuringComponent":{
                        "type":"object",
                        "properties":{
                            "measuringComponentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Measuring Component ID"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : rateHistory

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "rate":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Rate"
                    }
                }
            }
        }
    }
}

Nested Schema : servicePoints

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "spId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Service Point ID"
                            }
                        }
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start and end times that define the time period during which the usage subscription is active.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "overrideStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
                    },
                    "stopDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
                    },
                    "overrideStopDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
                    },
                    "usage":{
                        "type":"string",
                        "enum":[
                            "D1AD",
                            "D1CK",
                            "D1ST"
                        ],
                        "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
                        "example":"D1AD"
                    },
                    "usePercent":{
                        "type":"number",
                        "maximum":999.99,
                        "minimum":-999.99,
                        "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
                        "example":"100"
                    }
                }
            }
        }
    }
}

Nested Schema : usageCalculationGroups

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "calculationGroup":{
                        "type":"object",
                        "properties":{
                            "usageGroup":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Calculation Group"
                            }
                        }
                    },
                    "effectiveDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Effective Date/Time for calculation groups.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "expirationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Expiration date and time for calculation groups.",
                        "example":"2011-02-10T00:00:00-08:00"
                    }
                }
            }
        }
    }
}

Nested Schema : usageSubscriptionType

Type: object

Type of Usage Subscription

Show Source

• usageSubscriptionType: string
  Maximum Length: 30

  Type of Usage Subscription

  Example: E-RESAOH

{
    "type":"object",
    "description":"Type of Usage Subscription",
    "properties":{
        "usageSubscriptionType":{
            "type":"string",
            "maxLength":30,
            "description":"Type of Usage Subscription",
            "example":"E-RESAOH"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dynamicOption":{
                "type":"object",
                "properties":{
                    "dynamicOptionId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Dynamic Option ID"
                    }
                }
            },
            "effectiveDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Effective Date/Time for calculation groups.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "expirationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Expiration date and time for calculation groups.",
                "example":"2011-02-10T00:00:00-08:00"
            },
            "dynamicOptionOverrides":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "dynamicOptionEvent":{
                                    "type":"object",
                                    "properties":{
                                        "dynamicOptionEventId":{
                                            "type":"string",
                                            "maxLength":14,
                                            "description":"Dynamic Option Event ID"
                                        }
                                    }
                                },
                                "overrideDateTime":{
                                    "type":"string",
                                    "format":"date-time",
                                    "description":"Override Date/Time for dynamic option overrides.",
                                    "example":"2014-01-01T00:00:00-08:00"
                                },
                                "status":{
                                    "type":"string",
                                    "enum":[
                                        "D1AC",
                                        "D1IN"
                                    ],
                                    "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                    "example":"D1AC"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dynamicOption: object dynamicOption
• dynamicOptionOverrides: object dynamicOptionOverrides
• effectiveDateTime: string (date-time)
  Effective Date/Time for calculation groups.

  Example: 2014-01-01T00:00:00-08:00
• expirationDateTime: string (date-time)
  Expiration date and time for calculation groups.

  Example: 2011-02-10T00:00:00-08:00

{
    "type":"object",
    "properties":{
        "dynamicOption":{
            "type":"object",
            "properties":{
                "dynamicOptionId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Dynamic Option ID"
                }
            }
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective Date/Time for calculation groups.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "expirationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Expiration date and time for calculation groups.",
            "example":"2011-02-10T00:00:00-08:00"
        },
        "dynamicOptionOverrides":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "dynamicOptionEvent":{
                                "type":"object",
                                "properties":{
                                    "dynamicOptionEventId":{
                                        "type":"string",
                                        "maxLength":14,
                                        "description":"Dynamic Option Event ID"
                                    }
                                }
                            },
                            "overrideDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Override Date/Time for dynamic option overrides.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "status":{
                                "type":"string",
                                "enum":[
                                    "D1AC",
                                    "D1IN"
                                ],
                                "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                "example":"D1AC"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : dynamicOption

Type: object

Show Source

• dynamicOptionId: string
  Maximum Length: 12

  Dynamic Option ID

{
    "type":"object",
    "properties":{
        "dynamicOptionId":{
            "type":"string",
            "maxLength":12,
            "description":"Dynamic Option ID"
        }
    }
}

Nested Schema : dynamicOptionOverrides

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dynamicOptionEvent":{
                        "type":"object",
                        "properties":{
                            "dynamicOptionEventId":{
                                "type":"string",
                                "maxLength":14,
                                "description":"Dynamic Option Event ID"
                            }
                        }
                    },
                    "overrideDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Override Date/Time for dynamic option overrides.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "D1AC",
                            "D1IN"
                        ],
                        "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                        "example":"D1AC"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dynamicOptionEvent":{
                "type":"object",
                "properties":{
                    "dynamicOptionEventId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"Dynamic Option Event ID"
                    }
                }
            },
            "overrideDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Override Date/Time for dynamic option overrides.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "status":{
                "type":"string",
                "enum":[
                    "D1AC",
                    "D1IN"
                ],
                "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                "example":"D1AC"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dynamicOptionEvent: object dynamicOptionEvent
• overrideDateTime: string (date-time)
  Override Date/Time for dynamic option overrides.

  Example: 2014-01-01T00:00:00-08:00
• status: string
  Allowed Values: [ "D1AC", "D1IN" ]

  Dynamic option overrides with an override status set to "Active" that needs to be excluded from the calculation. * `D1AC` - Active, * `D1IN` - Inactive

  Example: D1AC

{
    "type":"object",
    "properties":{
        "dynamicOptionEvent":{
            "type":"object",
            "properties":{
                "dynamicOptionEventId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Dynamic Option Event ID"
                }
            }
        },
        "overrideDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Override Date/Time for dynamic option overrides.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "status":{
            "type":"string",
            "enum":[
                "D1AC",
                "D1IN"
            ],
            "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
            "example":"D1AC"
        }
    }
}

Nested Schema : dynamicOptionEvent

Type: object

Show Source

• dynamicOptionEventId: string
  Maximum Length: 14

  Dynamic Option Event ID

{
    "type":"object",
    "properties":{
        "dynamicOptionEventId":{
            "type":"string",
            "maxLength":14,
            "description":"Dynamic Option Event ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "factor":{
                "type":"object",
                "properties":{
                    "factor":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Factor"
                    }
                }
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The start and end times that define the time period during which the usage subscription is active.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "endDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The start and end times that define the time period during which the usage subscription is active."
            },
            "value":{
                "type":"number",
                "maximum":1.0E11,
                "minimum":-1.0E11,
                "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
                "example":"20"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• endDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.
• factor: object factor
• startDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.

  Example: 2014-01-01T00:00:00-08:00
• value: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.

  Example: 20

{
    "type":"object",
    "properties":{
        "factor":{
            "type":"object",
            "properties":{
                "factor":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Factor"
                }
            }
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active."
        },
        "value":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
            "example":"20"
        }
    }
}

Nested Schema : factor

Type: object

Show Source

• factor: string
  Maximum Length: 30

  Factor

{
    "type":"object",
    "properties":{
        "factor":{
            "type":"string",
            "maxLength":30,
            "description":"Factor"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "calculationGroup":{
                "type":"object",
                "properties":{
                    "calculationGroup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Calculation Group"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• calculationGroup: object calculationGroup
• effectiveDate: string (date)
  Effective Date

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "calculationGroup":{
            "type":"object",
            "properties":{
                "calculationGroup":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Calculation Group"
                }
            }
        }
    }
}

Nested Schema : calculationGroup

Type: object

Show Source

• calculationGroup: string
  Maximum Length: 30

  Calculation Group

{
    "type":"object",
    "properties":{
        "calculationGroup":{
            "type":"string",
            "maxLength":30,
            "description":"Calculation Group"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "relationshipType":{
                "type":"string",
                "enum":[
                    "D2CA",
                    "D2SR",
                    "ZZAA",
                    "ZZBR",
                    "ZZM1",
                    "ZZM2",
                    "ZZM3",
                    "ZZM4",
                    "ZZM5",
                    "ZZS1",
                    "ZZS2",
                    "ZZSE",
                    "ZZSI",
                    "ZZSM",
                    "ZZZL"
                ],
                "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
                "example":"D2CA"
            },
            "measuringComponent":{
                "type":"object",
                "properties":{
                    "measuringComponentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Measuring Component ID"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• measuringComponent: object measuringComponent
• relationshipType: string
  Allowed Values: [ "D2CA", "D2SR", "ZZAA", "ZZBR", "ZZM1", "ZZM2", "ZZM3", "ZZM4", "ZZM5", "ZZS1", "ZZS2", "ZZSE", "ZZSI", "ZZSM", "ZZZL" ]

  The type of relationship between the usage subscription and the measuring component. * `D2CA` - Consumption Aggregator, * `D2SR` - Standalone Data Request, * `ZZAA` - Consumption Verification, * `ZZBR` - Component Relationship Type, * `ZZM1` - MC Relationship Type 1, * `ZZM2` - MC Relationship Type 2, * `ZZM3` - MC Relationship Type 3, * `ZZM4` - MC Relationship Type 4, * `ZZM5` - MC Relationship Type 5, * `ZZS1` - Standalone 1, * `ZZS2` - Standalone 2, * `ZZSE` - Self Scheduler External, * `ZZSI` - Self Scheduler Interval, * `ZZSM` - Self Scheduler Market, * `ZZZL` - Market Zonal Load

  Example: D2CA

{
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "enum":[
                "D2CA",
                "D2SR",
                "ZZAA",
                "ZZBR",
                "ZZM1",
                "ZZM2",
                "ZZM3",
                "ZZM4",
                "ZZM5",
                "ZZS1",
                "ZZS2",
                "ZZSE",
                "ZZSI",
                "ZZSM",
                "ZZZL"
            ],
            "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
            "example":"D2CA"
        },
        "measuringComponent":{
            "type":"object",
            "properties":{
                "measuringComponentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Measuring Component ID"
                }
            }
        }
    }
}

Nested Schema : measuringComponent

Type: object

Show Source

• measuringComponentId: string
  Maximum Length: 12

  Measuring Component ID

{
    "type":"object",
    "properties":{
        "measuringComponentId":{
            "type":"string",
            "maxLength":12,
            "description":"Measuring Component ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "rate":{
                "type":"string",
                "maxLength":30,
                "description":"Rate"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• effectiveDate: string (date)
  Effective Date
• rate: string
  Maximum Length: 30

  Rate

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "rate":{
            "type":"string",
            "maxLength":30,
            "description":"Rate"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "servicePoint":{
                "type":"object",
                "properties":{
                    "spId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Service Point ID"
                    }
                }
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The start and end times that define the time period during which the usage subscription is active.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "overrideStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
            },
            "stopDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
            },
            "overrideStopDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
            },
            "usage":{
                "type":"string",
                "enum":[
                    "D1AD",
                    "D1CK",
                    "D1ST"
                ],
                "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
                "example":"D1AD"
            },
            "usePercent":{
                "type":"number",
                "maximum":999.99,
                "minimum":-999.99,
                "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
                "example":"100"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• overrideStartDateTime: string (date-time)
  An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used.
• overrideStopDateTime: string (date-time)
  An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used.
• servicePoint: object servicePoint
• startDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.

  Example: 2014-01-01T00:00:00-08:00
• stopDateTime: string (date-time)
  The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time.
• usage: string
  Allowed Values: [ "D1AD", "D1CK", "D1ST" ]

  A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription. * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - Subtract

  Example: D1AD
• usePercent: number
  Minimum Value: -999.99

  Maximum Value: 999.99

  The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.

  Example: 100

{
    "type":"object",
    "properties":{
        "servicePoint":{
            "type":"object",
            "properties":{
                "spId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Service Point ID"
                }
            }
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "overrideStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
        },
        "stopDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
        },
        "overrideStopDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
        },
        "usage":{
            "type":"string",
            "enum":[
                "D1AD",
                "D1CK",
                "D1ST"
            ],
            "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
            "example":"D1AD"
        },
        "usePercent":{
            "type":"number",
            "maximum":999.99,
            "minimum":-999.99,
            "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
            "example":"100"
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• spId: string
  Maximum Length: 12

  Service Point ID

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":12,
            "description":"Service Point ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "calculationGroup":{
                "type":"object",
                "properties":{
                    "usageGroup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Calculation Group"
                    }
                }
            },
            "effectiveDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Effective Date/Time for calculation groups.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "expirationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Expiration date and time for calculation groups.",
                "example":"2011-02-10T00:00:00-08:00"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• calculationGroup: object calculationGroup
• effectiveDateTime: string (date-time)
  Effective Date/Time for calculation groups.

  Example: 2014-01-01T00:00:00-08:00
• expirationDateTime: string (date-time)
  Expiration date and time for calculation groups.

  Example: 2011-02-10T00:00:00-08:00

{
    "type":"object",
    "properties":{
        "calculationGroup":{
            "type":"object",
            "properties":{
                "usageGroup":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Calculation Group"
                }
            }
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective Date/Time for calculation groups.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "expirationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Expiration date and time for calculation groups.",
            "example":"2011-02-10T00:00:00-08:00"
        }
    }
}

Nested Schema : calculationGroup

Type: object

Show Source

• usageGroup: string
  Maximum Length: 30

  Calculation Group

{
    "type":"object",
    "properties":{
        "usageGroup":{
            "type":"string",
            "maxLength":30,
            "description":"Calculation Group"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accessGroup: string
  Maximum Length: 12

  Access Group
• comments: string
  Maximum Length: 254

  Comments
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2015-12-18T16:08:26-08:00
• division: string
  Maximum Length: 30

  Divisions are used to delineate between different operating companies within a large conglomerate of utilities.

  Example: CA
• dynamicOptions: object dynamicOptions
• endDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.
• externalAccountId: string
  Maximum Length: 30

  ID used in an external application identify the usage subscription.

  Example: 22132634-15-KMUS
• externalId: string
  Maximum Length: 60

  ID used in an external application identify the usage subscription.

  Example: 22132634-01-KMUS
• factorOverrides: object factorOverrides
• fallbackUsageCalculationGroups: object fallbackUsageCalculationGroups
• mainContact: object mainContact
• masterUsageSubscription: string
  Maximum Length: 12

  "Master" and "sub" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service).
• measuringComponents: object measuringComponents
• mostRecentUsageTransactionDateTime: string (date-time)
  Most Recent Transaction Date/Time
• rateHistory: object rateHistory
• servicePoints: object servicePoints
• startDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.

  Example: 2014-01-01T00:00:00-08:00
• status: string
  Maximum Length: 12

  The current status of usage subscription.

  Example: Active
• statusDateTime: string (date-time)
  Status Date/Time

  Example: 2015-12-18T16:08:26-08:00
• timeZone: string
  Maximum Length: 10

  The time zone in which the usage subscription is active.

  Example: USPACIFIC
• usageApprovalRequired: string
  Allowed Values: [ "D1NR", "D1RQ" ]

  A flag that indicates if usage must be approved before being sent to the recipient. * `D1NR` - Not Required, * `D1RQ` - Required

  Example: D1NR
• usageCalculationGroups: object usageCalculationGroups
• usageRecipient: string
  Maximum Length: 30

  The service provider is used as the identity of the subscribing system.
• usageSubscriptionId: string
  Maximum Length: 12

  Usage Subscription ID is a system assigned random number that stays with a usage subscription record.

  Example: 543722442966
• usageSubscriptionMarketParticipant: string
  Maximum Length: 12

  Defines the Usage Subscription Market Participant associated with the child Usage Subscription.
• usageSubscriptionType: object usageSubscriptionType
  Type of Usage Subscription
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks

  Example: 5

{
    "type":"object",
    "properties":{
        "usageSubscriptionId":{
            "type":"string",
            "maxLength":12,
            "description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.",
            "example":"543722442966"
        },
        "usageSubscriptionType":{
            "type":"object",
            "description":"Type of Usage Subscription",
            "properties":{
                "usageSubscriptionType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Type of Usage Subscription",
                    "example":"E-RESAOH"
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"The current status of usage subscription.",
            "example":"Active"
        },
        "masterUsageSubscription":{
            "type":"string",
            "maxLength":12,
            "description":"\"Master\" and \"sub\" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service)."
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2015-12-18T16:08:26-08:00"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2015-12-18T16:08:26-08:00"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active."
        },
        "division":{
            "type":"string",
            "maxLength":30,
            "description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.",
            "example":"CA"
        },
        "accessGroup":{
            "type":"string",
            "maxLength":12,
            "description":"Access Group"
        },
        "mostRecentUsageTransactionDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Most Recent Transaction Date/Time"
        },
        "usageRecipient":{
            "type":"string",
            "maxLength":30,
            "description":"The service provider is used as the identity of the subscribing system."
        },
        "usageApprovalRequired":{
            "type":"string",
            "enum":[
                "D1NR",
                "D1RQ"
            ],
            "description":"A flag that indicates if usage must be approved before being sent to the recipient.\n* `D1NR` - Not Required,\n* `D1RQ` - Required",
            "example":"D1NR"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"ID used in an external application identify the usage subscription.",
            "example":"22132634-01-KMUS"
        },
        "externalAccountId":{
            "type":"string",
            "maxLength":30,
            "description":"ID used in an external application identify the usage subscription.",
            "example":"22132634-15-KMUS"
        },
        "mainContact":{
            "type":"object",
            "properties":{
                "mainContactId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The main contact for the usage subscription.",
                    "example":"003007788788"
                }
            }
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"The time zone in which the usage subscription is active.",
            "example":"USPACIFIC"
        },
        "usageSubscriptionMarketParticipant":{
            "type":"string",
            "maxLength":12,
            "description":"Defines the Usage Subscription Market Participant associated with the child Usage Subscription."
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks",
            "example":"5"
        },
        "servicePoints":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "servicePoint":{
                                "type":"object",
                                "properties":{
                                    "spId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Service Point ID"
                                    }
                                }
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start and end times that define the time period during which the usage subscription is active.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "overrideStartDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
                            },
                            "stopDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
                            },
                            "overrideStopDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
                            },
                            "usage":{
                                "type":"string",
                                "enum":[
                                    "D1AD",
                                    "D1CK",
                                    "D1ST"
                                ],
                                "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
                                "example":"D1AD"
                            },
                            "usePercent":{
                                "type":"number",
                                "maximum":999.99,
                                "minimum":-999.99,
                                "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
                                "example":"100"
                            }
                        }
                    }
                }
            }
        },
        "factorOverrides":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "factor":{
                                "type":"object",
                                "properties":{
                                    "factor":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Factor"
                                    }
                                }
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start and end times that define the time period during which the usage subscription is active.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start and end times that define the time period during which the usage subscription is active."
                            },
                            "value":{
                                "type":"number",
                                "maximum":1.0E11,
                                "minimum":-1.0E11,
                                "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
                                "example":"20"
                            }
                        }
                    }
                }
            }
        },
        "usageCalculationGroups":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "calculationGroup":{
                                "type":"object",
                                "properties":{
                                    "usageGroup":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Calculation Group"
                                    }
                                }
                            },
                            "effectiveDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Effective Date/Time for calculation groups.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "expirationDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Expiration date and time for calculation groups.",
                                "example":"2011-02-10T00:00:00-08:00"
                            }
                        }
                    }
                }
            }
        },
        "fallbackUsageCalculationGroups":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "calculationGroup":{
                                "type":"object",
                                "properties":{
                                    "calculationGroup":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Calculation Group"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "rateHistory":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "rate":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Rate"
                            }
                        }
                    }
                }
            }
        },
        "measuringComponents":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "relationshipType":{
                                "type":"string",
                                "enum":[
                                    "D2CA",
                                    "D2SR",
                                    "ZZAA",
                                    "ZZBR",
                                    "ZZM1",
                                    "ZZM2",
                                    "ZZM3",
                                    "ZZM4",
                                    "ZZM5",
                                    "ZZS1",
                                    "ZZS2",
                                    "ZZSE",
                                    "ZZSI",
                                    "ZZSM",
                                    "ZZZL"
                                ],
                                "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
                                "example":"D2CA"
                            },
                            "measuringComponent":{
                                "type":"object",
                                "properties":{
                                    "measuringComponentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Measuring Component ID"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "dynamicOptions":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "dynamicOption":{
                                "type":"object",
                                "properties":{
                                    "dynamicOptionId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Dynamic Option ID"
                                    }
                                }
                            },
                            "effectiveDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Effective Date/Time for calculation groups.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "expirationDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Expiration date and time for calculation groups.",
                                "example":"2011-02-10T00:00:00-08:00"
                            },
                            "dynamicOptionOverrides":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "dynamicOptionEvent":{
                                                    "type":"object",
                                                    "properties":{
                                                        "dynamicOptionEventId":{
                                                            "type":"string",
                                                            "maxLength":14,
                                                            "description":"Dynamic Option Event ID"
                                                        }
                                                    }
                                                },
                                                "overrideDateTime":{
                                                    "type":"string",
                                                    "format":"date-time",
                                                    "description":"Override Date/Time for dynamic option overrides.",
                                                    "example":"2014-01-01T00:00:00-08:00"
                                                },
                                                "status":{
                                                    "type":"string",
                                                    "enum":[
                                                        "D1AC",
                                                        "D1IN"
                                                    ],
                                                    "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                                    "example":"D1AC"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-UsageSubs"
    }
}

Nested Schema : dynamicOptions

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dynamicOption":{
                        "type":"object",
                        "properties":{
                            "dynamicOptionId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Dynamic Option ID"
                            }
                        }
                    },
                    "effectiveDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Effective Date/Time for calculation groups.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "expirationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Expiration date and time for calculation groups.",
                        "example":"2011-02-10T00:00:00-08:00"
                    },
                    "dynamicOptionOverrides":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "dynamicOptionEvent":{
                                            "type":"object",
                                            "properties":{
                                                "dynamicOptionEventId":{
                                                    "type":"string",
                                                    "maxLength":14,
                                                    "description":"Dynamic Option Event ID"
                                                }
                                            }
                                        },
                                        "overrideDateTime":{
                                            "type":"string",
                                            "format":"date-time",
                                            "description":"Override Date/Time for dynamic option overrides.",
                                            "example":"2014-01-01T00:00:00-08:00"
                                        },
                                        "status":{
                                            "type":"string",
                                            "enum":[
                                                "D1AC",
                                                "D1IN"
                                            ],
                                            "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                            "example":"D1AC"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : factorOverrides

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "factor":{
                        "type":"object",
                        "properties":{
                            "factor":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Factor"
                            }
                        }
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start and end times that define the time period during which the usage subscription is active.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start and end times that define the time period during which the usage subscription is active."
                    },
                    "value":{
                        "type":"number",
                        "maximum":1.0E11,
                        "minimum":-1.0E11,
                        "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
                        "example":"20"
                    }
                }
            }
        }
    }
}

Nested Schema : fallbackUsageCalculationGroups

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "calculationGroup":{
                        "type":"object",
                        "properties":{
                            "calculationGroup":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Calculation Group"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : mainContact

Type: object

Show Source

• mainContactId: string
  Maximum Length: 12

  The main contact for the usage subscription.

  Example: 003007788788

{
    "type":"object",
    "properties":{
        "mainContactId":{
            "type":"string",
            "maxLength":12,
            "description":"The main contact for the usage subscription.",
            "example":"003007788788"
        }
    }
}

Nested Schema : measuringComponents

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "relationshipType":{
                        "type":"string",
                        "enum":[
                            "D2CA",
                            "D2SR",
                            "ZZAA",
                            "ZZBR",
                            "ZZM1",
                            "ZZM2",
                            "ZZM3",
                            "ZZM4",
                            "ZZM5",
                            "ZZS1",
                            "ZZS2",
                            "ZZSE",
                            "ZZSI",
                            "ZZSM",
                            "ZZZL"
                        ],
                        "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
                        "example":"D2CA"
                    },
                    "measuringComponent":{
                        "type":"object",
                        "properties":{
                            "measuringComponentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Measuring Component ID"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : rateHistory

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "rate":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Rate"
                    }
                }
            }
        }
    }
}

Nested Schema : servicePoints

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "spId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Service Point ID"
                            }
                        }
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start and end times that define the time period during which the usage subscription is active.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "overrideStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
                    },
                    "stopDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
                    },
                    "overrideStopDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
                    },
                    "usage":{
                        "type":"string",
                        "enum":[
                            "D1AD",
                            "D1CK",
                            "D1ST"
                        ],
                        "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
                        "example":"D1AD"
                    },
                    "usePercent":{
                        "type":"number",
                        "maximum":999.99,
                        "minimum":-999.99,
                        "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
                        "example":"100"
                    }
                }
            }
        }
    }
}

Nested Schema : usageCalculationGroups

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "calculationGroup":{
                        "type":"object",
                        "properties":{
                            "usageGroup":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Calculation Group"
                            }
                        }
                    },
                    "effectiveDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Effective Date/Time for calculation groups.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "expirationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Expiration date and time for calculation groups.",
                        "example":"2011-02-10T00:00:00-08:00"
                    }
                }
            }
        }
    }
}

Nested Schema : usageSubscriptionType

Type: object

Type of Usage Subscription

Show Source

• usageSubscriptionType: string
  Maximum Length: 30

  Type of Usage Subscription

  Example: E-RESAOH

{
    "type":"object",
    "description":"Type of Usage Subscription",
    "properties":{
        "usageSubscriptionType":{
            "type":"string",
            "maxLength":30,
            "description":"Type of Usage Subscription",
            "example":"E-RESAOH"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dynamicOption":{
                "type":"object",
                "properties":{
                    "dynamicOptionId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Dynamic Option ID"
                    }
                }
            },
            "effectiveDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Effective Date/Time for calculation groups.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "expirationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Expiration date and time for calculation groups.",
                "example":"2011-02-10T00:00:00-08:00"
            },
            "dynamicOptionOverrides":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "dynamicOptionEvent":{
                                    "type":"object",
                                    "properties":{
                                        "dynamicOptionEventId":{
                                            "type":"string",
                                            "maxLength":14,
                                            "description":"Dynamic Option Event ID"
                                        }
                                    }
                                },
                                "overrideDateTime":{
                                    "type":"string",
                                    "format":"date-time",
                                    "description":"Override Date/Time for dynamic option overrides.",
                                    "example":"2014-01-01T00:00:00-08:00"
                                },
                                "status":{
                                    "type":"string",
                                    "enum":[
                                        "D1AC",
                                        "D1IN"
                                    ],
                                    "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                    "example":"D1AC"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dynamicOption: object dynamicOption
• dynamicOptionOverrides: object dynamicOptionOverrides
• effectiveDateTime: string (date-time)
  Effective Date/Time for calculation groups.

  Example: 2014-01-01T00:00:00-08:00
• expirationDateTime: string (date-time)
  Expiration date and time for calculation groups.

  Example: 2011-02-10T00:00:00-08:00

{
    "type":"object",
    "properties":{
        "dynamicOption":{
            "type":"object",
            "properties":{
                "dynamicOptionId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Dynamic Option ID"
                }
            }
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective Date/Time for calculation groups.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "expirationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Expiration date and time for calculation groups.",
            "example":"2011-02-10T00:00:00-08:00"
        },
        "dynamicOptionOverrides":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "dynamicOptionEvent":{
                                "type":"object",
                                "properties":{
                                    "dynamicOptionEventId":{
                                        "type":"string",
                                        "maxLength":14,
                                        "description":"Dynamic Option Event ID"
                                    }
                                }
                            },
                            "overrideDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Override Date/Time for dynamic option overrides.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "status":{
                                "type":"string",
                                "enum":[
                                    "D1AC",
                                    "D1IN"
                                ],
                                "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                "example":"D1AC"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : dynamicOption

Type: object

Show Source

• dynamicOptionId: string
  Maximum Length: 12

  Dynamic Option ID

{
    "type":"object",
    "properties":{
        "dynamicOptionId":{
            "type":"string",
            "maxLength":12,
            "description":"Dynamic Option ID"
        }
    }
}

Nested Schema : dynamicOptionOverrides

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dynamicOptionEvent":{
                        "type":"object",
                        "properties":{
                            "dynamicOptionEventId":{
                                "type":"string",
                                "maxLength":14,
                                "description":"Dynamic Option Event ID"
                            }
                        }
                    },
                    "overrideDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Override Date/Time for dynamic option overrides.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "D1AC",
                            "D1IN"
                        ],
                        "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                        "example":"D1AC"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dynamicOptionEvent":{
                "type":"object",
                "properties":{
                    "dynamicOptionEventId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"Dynamic Option Event ID"
                    }
                }
            },
            "overrideDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Override Date/Time for dynamic option overrides.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "status":{
                "type":"string",
                "enum":[
                    "D1AC",
                    "D1IN"
                ],
                "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                "example":"D1AC"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dynamicOptionEvent: object dynamicOptionEvent
• overrideDateTime: string (date-time)
  Override Date/Time for dynamic option overrides.

  Example: 2014-01-01T00:00:00-08:00
• status: string
  Allowed Values: [ "D1AC", "D1IN" ]

  Dynamic option overrides with an override status set to "Active" that needs to be excluded from the calculation. * `D1AC` - Active, * `D1IN` - Inactive

  Example: D1AC

{
    "type":"object",
    "properties":{
        "dynamicOptionEvent":{
            "type":"object",
            "properties":{
                "dynamicOptionEventId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Dynamic Option Event ID"
                }
            }
        },
        "overrideDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Override Date/Time for dynamic option overrides.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "status":{
            "type":"string",
            "enum":[
                "D1AC",
                "D1IN"
            ],
            "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
            "example":"D1AC"
        }
    }
}

Nested Schema : dynamicOptionEvent

Type: object

Show Source

• dynamicOptionEventId: string
  Maximum Length: 14

  Dynamic Option Event ID

{
    "type":"object",
    "properties":{
        "dynamicOptionEventId":{
            "type":"string",
            "maxLength":14,
            "description":"Dynamic Option Event ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "factor":{
                "type":"object",
                "properties":{
                    "factor":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Factor"
                    }
                }
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The start and end times that define the time period during which the usage subscription is active.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "endDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The start and end times that define the time period during which the usage subscription is active."
            },
            "value":{
                "type":"number",
                "maximum":1.0E11,
                "minimum":-1.0E11,
                "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
                "example":"20"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• endDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.
• factor: object factor
• startDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.

  Example: 2014-01-01T00:00:00-08:00
• value: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.

  Example: 20

{
    "type":"object",
    "properties":{
        "factor":{
            "type":"object",
            "properties":{
                "factor":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Factor"
                }
            }
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active."
        },
        "value":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
            "example":"20"
        }
    }
}

Nested Schema : factor

Type: object

Show Source

• factor: string
  Maximum Length: 30

  Factor

{
    "type":"object",
    "properties":{
        "factor":{
            "type":"string",
            "maxLength":30,
            "description":"Factor"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "calculationGroup":{
                "type":"object",
                "properties":{
                    "calculationGroup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Calculation Group"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• calculationGroup: object calculationGroup
• effectiveDate: string (date)
  Effective Date

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "calculationGroup":{
            "type":"object",
            "properties":{
                "calculationGroup":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Calculation Group"
                }
            }
        }
    }
}

Nested Schema : calculationGroup

Type: object

Show Source

• calculationGroup: string
  Maximum Length: 30

  Calculation Group

{
    "type":"object",
    "properties":{
        "calculationGroup":{
            "type":"string",
            "maxLength":30,
            "description":"Calculation Group"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "relationshipType":{
                "type":"string",
                "enum":[
                    "D2CA",
                    "D2SR",
                    "ZZAA",
                    "ZZBR",
                    "ZZM1",
                    "ZZM2",
                    "ZZM3",
                    "ZZM4",
                    "ZZM5",
                    "ZZS1",
                    "ZZS2",
                    "ZZSE",
                    "ZZSI",
                    "ZZSM",
                    "ZZZL"
                ],
                "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
                "example":"D2CA"
            },
            "measuringComponent":{
                "type":"object",
                "properties":{
                    "measuringComponentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Measuring Component ID"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• measuringComponent: object measuringComponent
• relationshipType: string
  Allowed Values: [ "D2CA", "D2SR", "ZZAA", "ZZBR", "ZZM1", "ZZM2", "ZZM3", "ZZM4", "ZZM5", "ZZS1", "ZZS2", "ZZSE", "ZZSI", "ZZSM", "ZZZL" ]

  The type of relationship between the usage subscription and the measuring component. * `D2CA` - Consumption Aggregator, * `D2SR` - Standalone Data Request, * `ZZAA` - Consumption Verification, * `ZZBR` - Component Relationship Type, * `ZZM1` - MC Relationship Type 1, * `ZZM2` - MC Relationship Type 2, * `ZZM3` - MC Relationship Type 3, * `ZZM4` - MC Relationship Type 4, * `ZZM5` - MC Relationship Type 5, * `ZZS1` - Standalone 1, * `ZZS2` - Standalone 2, * `ZZSE` - Self Scheduler External, * `ZZSI` - Self Scheduler Interval, * `ZZSM` - Self Scheduler Market, * `ZZZL` - Market Zonal Load

  Example: D2CA

{
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "enum":[
                "D2CA",
                "D2SR",
                "ZZAA",
                "ZZBR",
                "ZZM1",
                "ZZM2",
                "ZZM3",
                "ZZM4",
                "ZZM5",
                "ZZS1",
                "ZZS2",
                "ZZSE",
                "ZZSI",
                "ZZSM",
                "ZZZL"
            ],
            "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
            "example":"D2CA"
        },
        "measuringComponent":{
            "type":"object",
            "properties":{
                "measuringComponentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Measuring Component ID"
                }
            }
        }
    }
}

Nested Schema : measuringComponent

Type: object

Show Source

• measuringComponentId: string
  Maximum Length: 12

  Measuring Component ID

{
    "type":"object",
    "properties":{
        "measuringComponentId":{
            "type":"string",
            "maxLength":12,
            "description":"Measuring Component ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "rate":{
                "type":"string",
                "maxLength":30,
                "description":"Rate"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• effectiveDate: string (date)
  Effective Date
• rate: string
  Maximum Length: 30

  Rate

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "rate":{
            "type":"string",
            "maxLength":30,
            "description":"Rate"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "servicePoint":{
                "type":"object",
                "properties":{
                    "spId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Service Point ID"
                    }
                }
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The start and end times that define the time period during which the usage subscription is active.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "overrideStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
            },
            "stopDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
            },
            "overrideStopDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
            },
            "usage":{
                "type":"string",
                "enum":[
                    "D1AD",
                    "D1CK",
                    "D1ST"
                ],
                "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
                "example":"D1AD"
            },
            "usePercent":{
                "type":"number",
                "maximum":999.99,
                "minimum":-999.99,
                "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
                "example":"100"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• overrideStartDateTime: string (date-time)
  An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used.
• overrideStopDateTime: string (date-time)
  An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used.
• servicePoint: object servicePoint
• startDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.

  Example: 2014-01-01T00:00:00-08:00
• stopDateTime: string (date-time)
  The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time.
• usage: string
  Allowed Values: [ "D1AD", "D1CK", "D1ST" ]

  A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription. * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - Subtract

  Example: D1AD
• usePercent: number
  Minimum Value: -999.99

  Maximum Value: 999.99

  The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.

  Example: 100

{
    "type":"object",
    "properties":{
        "servicePoint":{
            "type":"object",
            "properties":{
                "spId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Service Point ID"
                }
            }
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "overrideStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
        },
        "stopDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
        },
        "overrideStopDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
        },
        "usage":{
            "type":"string",
            "enum":[
                "D1AD",
                "D1CK",
                "D1ST"
            ],
            "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
            "example":"D1AD"
        },
        "usePercent":{
            "type":"number",
            "maximum":999.99,
            "minimum":-999.99,
            "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
            "example":"100"
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• spId: string
  Maximum Length: 12

  Service Point ID

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":12,
            "description":"Service Point ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "calculationGroup":{
                "type":"object",
                "properties":{
                    "usageGroup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Calculation Group"
                    }
                }
            },
            "effectiveDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Effective Date/Time for calculation groups.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "expirationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Expiration date and time for calculation groups.",
                "example":"2011-02-10T00:00:00-08:00"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• calculationGroup: object calculationGroup
• effectiveDateTime: string (date-time)
  Effective Date/Time for calculation groups.

  Example: 2014-01-01T00:00:00-08:00
• expirationDateTime: string (date-time)
  Expiration date and time for calculation groups.

  Example: 2011-02-10T00:00:00-08:00

{
    "type":"object",
    "properties":{
        "calculationGroup":{
            "type":"object",
            "properties":{
                "usageGroup":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Calculation Group"
                }
            }
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective Date/Time for calculation groups.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "expirationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Expiration date and time for calculation groups.",
            "example":"2011-02-10T00:00:00-08:00"
        }
    }
}

Nested Schema : calculationGroup

Type: object

Show Source

• usageGroup: string
  Maximum Length: 30

  Calculation Group

{
    "type":"object",
    "properties":{
        "usageGroup":{
            "type":"string",
            "maxLength":30,
            "description":"Calculation Group"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : D1-UsageSubs

Type: object

Show Source

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

  Access Group
• comments: string
  Maximum Length: 254

  Comments
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2015-12-18T16:08:26-08:00
• division: string
  Maximum Length: 30

  Divisions are used to delineate between different operating companies within a large conglomerate of utilities.

  Example: CA
• dynamicOptions: object dynamicOptions
• endDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.
• externalAccountId: string
  Maximum Length: 30

  ID used in an external application identify the usage subscription.

  Example: 22132634-15-KMUS
• externalId: string
  Maximum Length: 60

  ID used in an external application identify the usage subscription.

  Example: 22132634-01-KMUS
• factorOverrides: object factorOverrides
• fallbackUsageCalculationGroups: object fallbackUsageCalculationGroups
• mainContact: object mainContact
• masterUsageSubscription: string
  Maximum Length: 12

  "Master" and "sub" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service).
• measuringComponents: object measuringComponents
• mostRecentUsageTransactionDateTime: string (date-time)
  Most Recent Transaction Date/Time
• rateHistory: object rateHistory
• servicePoints: object servicePoints
• startDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.

  Example: 2014-01-01T00:00:00-08:00
• status: string
  Maximum Length: 12

  The current status of usage subscription.

  Example: Active
• statusDateTime: string (date-time)
  Status Date/Time

  Example: 2015-12-18T16:08:26-08:00
• timeZone: string
  Maximum Length: 10

  The time zone in which the usage subscription is active.

  Example: USPACIFIC
• usageApprovalRequired: string
  Allowed Values: [ "D1NR", "D1RQ" ]

  A flag that indicates if usage must be approved before being sent to the recipient. * `D1NR` - Not Required, * `D1RQ` - Required

  Example: D1NR
• usageCalculationGroups: object usageCalculationGroups
• usageRecipient: string
  Maximum Length: 30

  The service provider is used as the identity of the subscribing system.
• usageSubscriptionId: string
  Maximum Length: 12

  Usage Subscription ID is a system assigned random number that stays with a usage subscription record.

  Example: 543722442966
• usageSubscriptionMarketParticipant: string
  Maximum Length: 12

  Defines the Usage Subscription Market Participant associated with the child Usage Subscription.
• usageSubscriptionType: object usageSubscriptionType
  Type of Usage Subscription
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks

  Example: 5

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "usageSubscriptionId":{
            "type":"string",
            "maxLength":12,
            "description":"Usage Subscription ID is a system assigned random number that stays with a usage subscription record.",
            "example":"543722442966"
        },
        "usageSubscriptionType":{
            "type":"object",
            "description":"Type of Usage Subscription",
            "properties":{
                "usageSubscriptionType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Type of Usage Subscription",
                    "example":"E-RESAOH"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"The current status of usage subscription.",
            "example":"Active"
        },
        "masterUsageSubscription":{
            "type":"string",
            "maxLength":12,
            "description":"\"Master\" and \"sub\" usage subscriptions allow for hierarchical relationships between usage subscription to represent situations where a subscription is a subordinate to another usage subscription (such as when a utility is issuing a bill for a third-party service)."
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2015-12-18T16:08:26-08:00"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2015-12-18T16:08:26-08:00"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active."
        },
        "division":{
            "type":"string",
            "maxLength":30,
            "description":"Divisions are used to delineate between different operating companies within a large conglomerate of utilities.",
            "example":"CA"
        },
        "accessGroup":{
            "type":"string",
            "maxLength":12,
            "description":"Access Group"
        },
        "mostRecentUsageTransactionDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Most Recent Transaction Date/Time"
        },
        "usageRecipient":{
            "type":"string",
            "maxLength":30,
            "description":"The service provider is used as the identity of the subscribing system."
        },
        "usageApprovalRequired":{
            "type":"string",
            "enum":[
                "D1NR",
                "D1RQ"
            ],
            "description":"A flag that indicates if usage must be approved before being sent to the recipient.\n* `D1NR` - Not Required,\n* `D1RQ` - Required",
            "example":"D1NR"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"ID used in an external application identify the usage subscription.",
            "example":"22132634-01-KMUS"
        },
        "externalAccountId":{
            "type":"string",
            "maxLength":30,
            "description":"ID used in an external application identify the usage subscription.",
            "example":"22132634-15-KMUS"
        },
        "mainContact":{
            "type":"object",
            "properties":{
                "mainContactId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The main contact for the usage subscription.",
                    "example":"003007788788"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"The time zone in which the usage subscription is active.",
            "example":"USPACIFIC"
        },
        "usageSubscriptionMarketParticipant":{
            "type":"string",
            "maxLength":12,
            "description":"Defines the Usage Subscription Market Participant associated with the child Usage Subscription."
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks",
            "example":"5"
        },
        "servicePoints":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "servicePoint":{
                                "type":"object",
                                "properties":{
                                    "spId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Service Point ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start and end times that define the time period during which the usage subscription is active.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "overrideStartDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
                            },
                            "stopDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
                            },
                            "overrideStopDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
                            },
                            "usage":{
                                "type":"string",
                                "enum":[
                                    "D1AD",
                                    "D1CK",
                                    "D1ST"
                                ],
                                "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
                                "example":"D1AD"
                            },
                            "usePercent":{
                                "type":"number",
                                "maximum":999.99,
                                "minimum":-999.99,
                                "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
                                "example":"100"
                            }
                        }
                    }
                }
            }
        },
        "factorOverrides":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "factor":{
                                "type":"object",
                                "properties":{
                                    "factor":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Factor"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start and end times that define the time period during which the usage subscription is active.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start and end times that define the time period during which the usage subscription is active."
                            },
                            "value":{
                                "type":"number",
                                "maximum":1.0E11,
                                "minimum":-1.0E11,
                                "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
                                "example":"20"
                            }
                        }
                    }
                }
            }
        },
        "usageCalculationGroups":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "calculationGroup":{
                                "type":"object",
                                "properties":{
                                    "usageGroup":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Calculation Group"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "effectiveDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Effective Date/Time for calculation groups.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "expirationDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Expiration date and time for calculation groups.",
                                "example":"2011-02-10T00:00:00-08:00"
                            }
                        }
                    }
                }
            }
        },
        "fallbackUsageCalculationGroups":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "calculationGroup":{
                                "type":"object",
                                "properties":{
                                    "calculationGroup":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Calculation Group"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "rateHistory":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "rate":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Rate"
                            }
                        }
                    }
                }
            }
        },
        "measuringComponents":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "relationshipType":{
                                "type":"string",
                                "enum":[
                                    "D2CA",
                                    "D2SR",
                                    "ZZAA",
                                    "ZZBR",
                                    "ZZM1",
                                    "ZZM2",
                                    "ZZM3",
                                    "ZZM4",
                                    "ZZM5",
                                    "ZZS1",
                                    "ZZS2",
                                    "ZZSE",
                                    "ZZSI",
                                    "ZZSM",
                                    "ZZZL"
                                ],
                                "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
                                "example":"D2CA"
                            },
                            "measuringComponent":{
                                "type":"object",
                                "properties":{
                                    "measuringComponentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Measuring Component ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "dynamicOptions":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "dynamicOption":{
                                "type":"object",
                                "properties":{
                                    "dynamicOptionId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Dynamic Option ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "effectiveDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Effective Date/Time for calculation groups.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "expirationDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Expiration date and time for calculation groups.",
                                "example":"2011-02-10T00:00:00-08:00"
                            },
                            "dynamicOptionOverrides":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "dynamicOptionEvent":{
                                                    "type":"object",
                                                    "properties":{
                                                        "dynamicOptionEventId":{
                                                            "type":"string",
                                                            "maxLength":14,
                                                            "description":"Dynamic Option Event ID"
                                                        },
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        }
                                                    }
                                                },
                                                "overrideDateTime":{
                                                    "type":"string",
                                                    "format":"date-time",
                                                    "description":"Override Date/Time for dynamic option overrides.",
                                                    "example":"2014-01-01T00:00:00-08:00"
                                                },
                                                "status":{
                                                    "type":"string",
                                                    "enum":[
                                                        "D1AC",
                                                        "D1IN"
                                                    ],
                                                    "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                                    "example":"D1AC"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-UsageSubs"
    }
}

Nested Schema : dynamicOptions

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dynamicOption":{
                        "type":"object",
                        "properties":{
                            "dynamicOptionId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Dynamic Option ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "effectiveDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Effective Date/Time for calculation groups.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "expirationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Expiration date and time for calculation groups.",
                        "example":"2011-02-10T00:00:00-08:00"
                    },
                    "dynamicOptionOverrides":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "dynamicOptionEvent":{
                                            "type":"object",
                                            "properties":{
                                                "dynamicOptionEventId":{
                                                    "type":"string",
                                                    "maxLength":14,
                                                    "description":"Dynamic Option Event ID"
                                                },
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                }
                                            }
                                        },
                                        "overrideDateTime":{
                                            "type":"string",
                                            "format":"date-time",
                                            "description":"Override Date/Time for dynamic option overrides.",
                                            "example":"2014-01-01T00:00:00-08:00"
                                        },
                                        "status":{
                                            "type":"string",
                                            "enum":[
                                                "D1AC",
                                                "D1IN"
                                            ],
                                            "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                            "example":"D1AC"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : factorOverrides

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "factor":{
                        "type":"object",
                        "properties":{
                            "factor":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Factor"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start and end times that define the time period during which the usage subscription is active.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start and end times that define the time period during which the usage subscription is active."
                    },
                    "value":{
                        "type":"number",
                        "maximum":1.0E11,
                        "minimum":-1.0E11,
                        "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
                        "example":"20"
                    }
                }
            }
        }
    }
}

Nested Schema : fallbackUsageCalculationGroups

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "calculationGroup":{
                        "type":"object",
                        "properties":{
                            "calculationGroup":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Calculation Group"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : mainContact

Type: object

Show Source

• _link: string
  _link
• mainContactId: string
  Maximum Length: 12

  The main contact for the usage subscription.

  Example: 003007788788

{
    "type":"object",
    "properties":{
        "mainContactId":{
            "type":"string",
            "maxLength":12,
            "description":"The main contact for the usage subscription.",
            "example":"003007788788"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : measuringComponents

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "relationshipType":{
                        "type":"string",
                        "enum":[
                            "D2CA",
                            "D2SR",
                            "ZZAA",
                            "ZZBR",
                            "ZZM1",
                            "ZZM2",
                            "ZZM3",
                            "ZZM4",
                            "ZZM5",
                            "ZZS1",
                            "ZZS2",
                            "ZZSE",
                            "ZZSI",
                            "ZZSM",
                            "ZZZL"
                        ],
                        "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
                        "example":"D2CA"
                    },
                    "measuringComponent":{
                        "type":"object",
                        "properties":{
                            "measuringComponentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Measuring Component ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : rateHistory

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "rate":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Rate"
                    }
                }
            }
        }
    }
}

Nested Schema : servicePoints

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "spId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Service Point ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start and end times that define the time period during which the usage subscription is active.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "overrideStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
                    },
                    "stopDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
                    },
                    "overrideStopDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
                    },
                    "usage":{
                        "type":"string",
                        "enum":[
                            "D1AD",
                            "D1CK",
                            "D1ST"
                        ],
                        "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
                        "example":"D1AD"
                    },
                    "usePercent":{
                        "type":"number",
                        "maximum":999.99,
                        "minimum":-999.99,
                        "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
                        "example":"100"
                    }
                }
            }
        }
    }
}

Nested Schema : usageCalculationGroups

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "calculationGroup":{
                        "type":"object",
                        "properties":{
                            "usageGroup":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Calculation Group"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "effectiveDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Effective Date/Time for calculation groups.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "expirationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Expiration date and time for calculation groups.",
                        "example":"2011-02-10T00:00:00-08:00"
                    }
                }
            }
        }
    }
}

Nested Schema : usageSubscriptionType

Type: object

Type of Usage Subscription

Show Source

• _link: string
  _link
• usageSubscriptionType: string
  Maximum Length: 30

  Type of Usage Subscription

  Example: E-RESAOH

{
    "type":"object",
    "description":"Type of Usage Subscription",
    "properties":{
        "usageSubscriptionType":{
            "type":"string",
            "maxLength":30,
            "description":"Type of Usage Subscription",
            "example":"E-RESAOH"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dynamicOption":{
                "type":"object",
                "properties":{
                    "dynamicOptionId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Dynamic Option ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "effectiveDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Effective Date/Time for calculation groups.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "expirationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Expiration date and time for calculation groups.",
                "example":"2011-02-10T00:00:00-08:00"
            },
            "dynamicOptionOverrides":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "dynamicOptionEvent":{
                                    "type":"object",
                                    "properties":{
                                        "dynamicOptionEventId":{
                                            "type":"string",
                                            "maxLength":14,
                                            "description":"Dynamic Option Event ID"
                                        },
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        }
                                    }
                                },
                                "overrideDateTime":{
                                    "type":"string",
                                    "format":"date-time",
                                    "description":"Override Date/Time for dynamic option overrides.",
                                    "example":"2014-01-01T00:00:00-08:00"
                                },
                                "status":{
                                    "type":"string",
                                    "enum":[
                                        "D1AC",
                                        "D1IN"
                                    ],
                                    "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                    "example":"D1AC"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dynamicOption: object dynamicOption
• dynamicOptionOverrides: object dynamicOptionOverrides
• effectiveDateTime: string (date-time)
  Effective Date/Time for calculation groups.

  Example: 2014-01-01T00:00:00-08:00
• expirationDateTime: string (date-time)
  Expiration date and time for calculation groups.

  Example: 2011-02-10T00:00:00-08:00

{
    "type":"object",
    "properties":{
        "dynamicOption":{
            "type":"object",
            "properties":{
                "dynamicOptionId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Dynamic Option ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective Date/Time for calculation groups.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "expirationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Expiration date and time for calculation groups.",
            "example":"2011-02-10T00:00:00-08:00"
        },
        "dynamicOptionOverrides":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "dynamicOptionEvent":{
                                "type":"object",
                                "properties":{
                                    "dynamicOptionEventId":{
                                        "type":"string",
                                        "maxLength":14,
                                        "description":"Dynamic Option Event ID"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "overrideDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Override Date/Time for dynamic option overrides.",
                                "example":"2014-01-01T00:00:00-08:00"
                            },
                            "status":{
                                "type":"string",
                                "enum":[
                                    "D1AC",
                                    "D1IN"
                                ],
                                "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                                "example":"D1AC"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : dynamicOption

Type: object

Show Source

• _link: string
  _link
• dynamicOptionId: string
  Maximum Length: 12

  Dynamic Option ID

{
    "type":"object",
    "properties":{
        "dynamicOptionId":{
            "type":"string",
            "maxLength":12,
            "description":"Dynamic Option ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : dynamicOptionOverrides

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "dynamicOptionEvent":{
                        "type":"object",
                        "properties":{
                            "dynamicOptionEventId":{
                                "type":"string",
                                "maxLength":14,
                                "description":"Dynamic Option Event ID"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "overrideDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Override Date/Time for dynamic option overrides.",
                        "example":"2014-01-01T00:00:00-08:00"
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "D1AC",
                            "D1IN"
                        ],
                        "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                        "example":"D1AC"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "dynamicOptionEvent":{
                "type":"object",
                "properties":{
                    "dynamicOptionEventId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"Dynamic Option Event ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "overrideDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Override Date/Time for dynamic option overrides.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "status":{
                "type":"string",
                "enum":[
                    "D1AC",
                    "D1IN"
                ],
                "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
                "example":"D1AC"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dynamicOptionEvent: object dynamicOptionEvent
• overrideDateTime: string (date-time)
  Override Date/Time for dynamic option overrides.

  Example: 2014-01-01T00:00:00-08:00
• status: string
  Allowed Values: [ "D1AC", "D1IN" ]

  Dynamic option overrides with an override status set to "Active" that needs to be excluded from the calculation. * `D1AC` - Active, * `D1IN` - Inactive

  Example: D1AC

{
    "type":"object",
    "properties":{
        "dynamicOptionEvent":{
            "type":"object",
            "properties":{
                "dynamicOptionEventId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Dynamic Option Event ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "overrideDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Override Date/Time for dynamic option overrides.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "status":{
            "type":"string",
            "enum":[
                "D1AC",
                "D1IN"
            ],
            "description":"Dynamic option overrides with an override status set to \"Active\" that needs to be excluded from the calculation.\n* `D1AC` - Active,\n* `D1IN` - Inactive",
            "example":"D1AC"
        }
    }
}

Nested Schema : dynamicOptionEvent

Type: object

Show Source

• _link: string
  _link
• dynamicOptionEventId: string
  Maximum Length: 14

  Dynamic Option Event ID

{
    "type":"object",
    "properties":{
        "dynamicOptionEventId":{
            "type":"string",
            "maxLength":14,
            "description":"Dynamic Option Event ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "factor":{
                "type":"object",
                "properties":{
                    "factor":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Factor"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The start and end times that define the time period during which the usage subscription is active.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "endDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The start and end times that define the time period during which the usage subscription is active."
            },
            "value":{
                "type":"number",
                "maximum":1.0E11,
                "minimum":-1.0E11,
                "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
                "example":"20"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• endDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.
• factor: object factor
• startDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.

  Example: 2014-01-01T00:00:00-08:00
• value: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.

  Example: 20

{
    "type":"object",
    "properties":{
        "factor":{
            "type":"object",
            "properties":{
                "factor":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Factor"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active."
        },
        "value":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"If the factor has a value defined on the usage subscription, this value is used instead of the value from the factor tables.",
            "example":"20"
        }
    }
}

Nested Schema : factor

Type: object

Show Source

• _link: string
  _link
• factor: string
  Maximum Length: 30

  Factor

{
    "type":"object",
    "properties":{
        "factor":{
            "type":"string",
            "maxLength":30,
            "description":"Factor"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "calculationGroup":{
                "type":"object",
                "properties":{
                    "calculationGroup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Calculation Group"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• calculationGroup: object calculationGroup
• effectiveDate: string (date)
  Effective Date

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "calculationGroup":{
            "type":"object",
            "properties":{
                "calculationGroup":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Calculation Group"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        }
    }
}

Nested Schema : calculationGroup

Type: object

Show Source

• _link: string
  _link
• calculationGroup: string
  Maximum Length: 30

  Calculation Group

{
    "type":"object",
    "properties":{
        "calculationGroup":{
            "type":"string",
            "maxLength":30,
            "description":"Calculation Group"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "relationshipType":{
                "type":"string",
                "enum":[
                    "D2CA",
                    "D2SR",
                    "ZZAA",
                    "ZZBR",
                    "ZZM1",
                    "ZZM2",
                    "ZZM3",
                    "ZZM4",
                    "ZZM5",
                    "ZZS1",
                    "ZZS2",
                    "ZZSE",
                    "ZZSI",
                    "ZZSM",
                    "ZZZL"
                ],
                "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
                "example":"D2CA"
            },
            "measuringComponent":{
                "type":"object",
                "properties":{
                    "measuringComponentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Measuring Component ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• measuringComponent: object measuringComponent
• relationshipType: string
  Allowed Values: [ "D2CA", "D2SR", "ZZAA", "ZZBR", "ZZM1", "ZZM2", "ZZM3", "ZZM4", "ZZM5", "ZZS1", "ZZS2", "ZZSE", "ZZSI", "ZZSM", "ZZZL" ]

  The type of relationship between the usage subscription and the measuring component. * `D2CA` - Consumption Aggregator, * `D2SR` - Standalone Data Request, * `ZZAA` - Consumption Verification, * `ZZBR` - Component Relationship Type, * `ZZM1` - MC Relationship Type 1, * `ZZM2` - MC Relationship Type 2, * `ZZM3` - MC Relationship Type 3, * `ZZM4` - MC Relationship Type 4, * `ZZM5` - MC Relationship Type 5, * `ZZS1` - Standalone 1, * `ZZS2` - Standalone 2, * `ZZSE` - Self Scheduler External, * `ZZSI` - Self Scheduler Interval, * `ZZSM` - Self Scheduler Market, * `ZZZL` - Market Zonal Load

  Example: D2CA

{
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "enum":[
                "D2CA",
                "D2SR",
                "ZZAA",
                "ZZBR",
                "ZZM1",
                "ZZM2",
                "ZZM3",
                "ZZM4",
                "ZZM5",
                "ZZS1",
                "ZZS2",
                "ZZSE",
                "ZZSI",
                "ZZSM",
                "ZZZL"
            ],
            "description":"The type of relationship between the usage subscription and the measuring component.\n* `D2CA` - Consumption Aggregator,\n* `D2SR` - Standalone Data Request,\n* `ZZAA` - Consumption Verification,\n* `ZZBR` - Component Relationship Type,\n* `ZZM1` - MC Relationship Type 1,\n* `ZZM2` - MC Relationship Type 2,\n* `ZZM3` - MC Relationship Type 3,\n* `ZZM4` - MC Relationship Type 4,\n* `ZZM5` - MC Relationship Type 5,\n* `ZZS1` - Standalone 1,\n* `ZZS2` - Standalone 2,\n* `ZZSE` - Self Scheduler External,\n* `ZZSI` - Self Scheduler Interval,\n* `ZZSM` - Self Scheduler Market,\n* `ZZZL` - Market Zonal Load",
            "example":"D2CA"
        },
        "measuringComponent":{
            "type":"object",
            "properties":{
                "measuringComponentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Measuring Component ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        }
    }
}

Nested Schema : measuringComponent

Type: object

Show Source

• _link: string
  _link
• measuringComponentId: string
  Maximum Length: 12

  Measuring Component ID

{
    "type":"object",
    "properties":{
        "measuringComponentId":{
            "type":"string",
            "maxLength":12,
            "description":"Measuring Component ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "rate":{
                "type":"string",
                "maxLength":30,
                "description":"Rate"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• effectiveDate: string (date)
  Effective Date
• rate: string
  Maximum Length: 30

  Rate

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "rate":{
            "type":"string",
            "maxLength":30,
            "description":"Rate"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "servicePoint":{
                "type":"object",
                "properties":{
                    "spId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Service Point ID"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The start and end times that define the time period during which the usage subscription is active.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "overrideStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
            },
            "stopDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
            },
            "overrideStopDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
            },
            "usage":{
                "type":"string",
                "enum":[
                    "D1AD",
                    "D1CK",
                    "D1ST"
                ],
                "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
                "example":"D1AD"
            },
            "usePercent":{
                "type":"number",
                "maximum":999.99,
                "minimum":-999.99,
                "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
                "example":"100"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• overrideStartDateTime: string (date-time)
  An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used.
• overrideStopDateTime: string (date-time)
  An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used.
• servicePoint: object servicePoint
• startDateTime: string (date-time)
  The start and end times that define the time period during which the usage subscription is active.

  Example: 2014-01-01T00:00:00-08:00
• stopDateTime: string (date-time)
  The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time.
• usage: string
  Allowed Values: [ "D1AD", "D1CK", "D1ST" ]

  A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription. * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - Subtract

  Example: D1AD
• usePercent: number
  Minimum Value: -999.99

  Maximum Value: 999.99

  The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.

  Example: 100

{
    "type":"object",
    "properties":{
        "servicePoint":{
            "type":"object",
            "properties":{
                "spId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Service Point ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start and end times that define the time period during which the usage subscription is active.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "overrideStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An override date and time used to specify the start date and time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Start Date/Time is used."
        },
        "stopDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The stop date and time of the relationship between the usage subscription and the service point. All measurements used calculate usage for the usage subscription should have a stop date/time before than this date and time."
        },
        "overrideStopDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An override date and time used to specify the stop date time when identifying measurements used to calculate usage for the usage subscription. If not specified, the Stop Date/Time is used."
        },
        "usage":{
            "type":"string",
            "enum":[
                "D1AD",
                "D1CK",
                "D1ST"
            ],
            "description":"A flag that indicates how the consumption from this service point is used when calculating usage for the usage subscription.\n* `D1AD` - Add,\n* `D1CK` - Exclude,\n* `D1ST` - Subtract",
            "example":"D1AD"
        },
        "usePercent":{
            "type":"number",
            "maximum":999.99,
            "minimum":-999.99,
            "description":"The percentage of consumption from this service point that should be used when calculating usage for the usage subscription.",
            "example":"100"
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• _link: string
  _link
• spId: string
  Maximum Length: 12

  Service Point ID

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":12,
            "description":"Service Point ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "calculationGroup":{
                "type":"object",
                "properties":{
                    "usageGroup":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Calculation Group"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "effectiveDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Effective Date/Time for calculation groups.",
                "example":"2014-01-01T00:00:00-08:00"
            },
            "expirationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Expiration date and time for calculation groups.",
                "example":"2011-02-10T00:00:00-08:00"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• calculationGroup: object calculationGroup
• effectiveDateTime: string (date-time)
  Effective Date/Time for calculation groups.

  Example: 2014-01-01T00:00:00-08:00
• expirationDateTime: string (date-time)
  Expiration date and time for calculation groups.

  Example: 2011-02-10T00:00:00-08:00

{
    "type":"object",
    "properties":{
        "calculationGroup":{
            "type":"object",
            "properties":{
                "usageGroup":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Calculation Group"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective Date/Time for calculation groups.",
            "example":"2014-01-01T00:00:00-08:00"
        },
        "expirationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Expiration date and time for calculation groups.",
            "example":"2011-02-10T00:00:00-08:00"
        }
    }
}

Nested Schema : calculationGroup

Type: object

Show Source

• _link: string
  _link
• usageGroup: string
  Maximum Length: 30

  Calculation Group

{
    "type":"object",
    "properties":{
        "usageGroup":{
            "type":"string",
            "maxLength":30,
            "description":"Calculation Group"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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