Jump to

• Request
• Response

Enroll Additional Device Service

post

/rest/apis/cross/digitalAssets/programEnrollments/enrollDevice

This operation enrolls an additional device to a customer's existing program enrollment. The device can be customer-owned or shipped from the utility.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• assetInfo: object assetInfo
• customerInfo: object customerInfo
• locationInfo: object locationInfo
• programInfo: object programInfo

{
    "type":"object",
    "properties":{
        "customerInfo":{
            "type":"object",
            "properties":{
                "cisPersonId":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
                },
                "cisAccountId":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
                },
                "name":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
                },
                "homePhone":{
                    "type":"string",
                    "maxLength":24,
                    "description":"Phone Number"
                },
                "businessPhone":{
                    "type":"string",
                    "maxLength":24,
                    "description":"Phone Number"
                },
                "contactNumber":{
                    "type":"string",
                    "maxLength":24,
                    "description":"Phone Number"
                },
                "email":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
                }
            }
        },
        "programInfo":{
            "type":"object",
            "properties":{
                "cisServiceAgreementId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The CIS Service Agreement ID associated to the metered service. Optional."
                },
                "programCode":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Program Code of the program being enrolled"
                },
                "startDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The desired application date of the enrollment."
                }
            }
        },
        "locationInfo":{
            "type":"object",
            "properties":{
                "cisPremiseId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
                },
                "cisServicePointID":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
                },
                "division":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Division is used to define the jurisdiction in which the customer is located."
                },
                "timeZone":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Time Zone"
                },
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"The country of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The city of the address. Used to derive the metered service point associated to the enrollment."
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The county of the address. Used to derive the metered service point associated to the enrollment."
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the address. Used to derive the metered service point associated to the enrollment."
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment."
                }
            }
        },
        "assetInfo":{
            "type":"object",
            "properties":{
                "installationMethod":{
                    "type":"string",
                    "enum":[
                        "X1RE",
                        "X1SD",
                        "X1SI",
                        "X1UI"
                    ],
                    "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `X1RE` - Re-enroll,\n* `X1SD` - Ship Device,\n* `X1SI` - Bring Your Own,\n* `X1UI` - Utility Installation"
                },
                "assetOwnership":{
                    "type":"string",
                    "enum":[
                        "W1CO",
                        "W1OW"
                    ],
                    "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned"
                },
                "assetList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":0,
                                "description":"Sequence"
                            },
                            "assetId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional."
                            },
                            "specification":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                            },
                            "assetType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                            },
                            "badgeNo":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
                            },
                            "serialNo":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
                            },
                            "nicId":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                            },
                            "headEndSystem":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1DAAdEnroll"
    }
}

Nested Schema : assetInfo

Type: object

Show Source

• assetList: array assetList
• assetOwnership: string
  Allowed Values: [ "W1CO", "W1OW" ]

  Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location. * `W1CO` - Customer Owned, * `W1OW` - Utility Owned
• installationMethod: string
  Allowed Values: [ "X1RE", "X1SD", "X1SI", "X1UI" ]

  Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location. * `X1RE` - Re-enroll, * `X1SD` - Ship Device, * `X1SI` - Bring Your Own, * `X1UI` - Utility Installation

{
    "type":"object",
    "properties":{
        "installationMethod":{
            "type":"string",
            "enum":[
                "X1RE",
                "X1SD",
                "X1SI",
                "X1UI"
            ],
            "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `X1RE` - Re-enroll,\n* `X1SD` - Ship Device,\n* `X1SI` - Bring Your Own,\n* `X1UI` - Utility Installation"
        },
        "assetOwnership":{
            "type":"string",
            "enum":[
                "W1CO",
                "W1OW"
            ],
            "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned"
        },
        "assetList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":0,
                        "description":"Sequence"
                    },
                    "assetId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional."
                    },
                    "specification":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                    },
                    "assetType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                    },
                    "badgeNo":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
                    },
                    "serialNo":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
                    },
                    "nicId":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                    },
                    "headEndSystem":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                    }
                }
            }
        }
    }
}

Nested Schema : customerInfo

Type: object

Show Source

• businessPhone: string
  Maximum Length: 24

  Phone Number
• cisAccountId: string
  Maximum Length: 30

  The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided.
• cisPersonId: string
  Maximum Length: 30

  The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided.
• contactNumber: string
  Maximum Length: 24

  Phone Number
• email: string
  Maximum Length: 254

  The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
• homePhone: string
  Maximum Length: 24

  Phone Number
• name: string
  Maximum Length: 254

  The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment.

{
    "type":"object",
    "properties":{
        "cisPersonId":{
            "type":"string",
            "maxLength":30,
            "description":"The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
        },
        "cisAccountId":{
            "type":"string",
            "maxLength":30,
            "description":"The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
        },
        "name":{
            "type":"string",
            "maxLength":254,
            "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        },
        "homePhone":{
            "type":"string",
            "maxLength":24,
            "description":"Phone Number"
        },
        "businessPhone":{
            "type":"string",
            "maxLength":24,
            "description":"Phone Number"
        },
        "contactNumber":{
            "type":"string",
            "maxLength":24,
            "description":"Phone Number"
        },
        "email":{
            "type":"string",
            "maxLength":254,
            "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        }
    }
}

Nested Schema : locationInfo

Type: object

Show Source

• address1: string
  Maximum Length: 254

  The first line of the address. Used to derive the metered service point associated to the enrollment.
• address2: string
  Maximum Length: 254

  The second line of the address. Used to derive the metered service point associated to the enrollment.
• address3: string
  Maximum Length: 254

  The third line of the address. Used to derive the metered service point associated to the enrollment.
• address4: string
  Maximum Length: 254

  The fourth line of the address. Used to derive the metered service point associated to the enrollment.
• cisPremiseId: string
  Maximum Length: 60

  The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided.
• cisServicePointID: string
  Maximum Length: 60

  The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided.
• city: string
  Maximum Length: 90

  The city of the address. Used to derive the metered service point associated to the enrollment.
• country: string
  Maximum Length: 3

  The country of the address. Used to derive the metered service point associated to the enrollment.
• county: string
  Maximum Length: 90

  The county of the address. Used to derive the metered service point associated to the enrollment.
• division: string
  Maximum Length: 30

  Division is used to define the jurisdiction in which the customer is located.
• postal: string
  Maximum Length: 12

  The postal code of the address. Used to derive the metered service point associated to the enrollment.
• state: string
  Maximum Length: 6

  The state of the address. Used to derive the metered service point associated to the enrollment.
• timeZone: string
  Maximum Length: 10

  Time Zone

{
    "type":"object",
    "properties":{
        "cisPremiseId":{
            "type":"string",
            "maxLength":60,
            "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
        },
        "cisServicePointID":{
            "type":"string",
            "maxLength":60,
            "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
        },
        "division":{
            "type":"string",
            "maxLength":30,
            "description":"Division is used to define the jurisdiction in which the customer is located."
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Time Zone"
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"The country of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the address. Used to derive the metered service point associated to the enrollment."
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the address. Used to derive the metered service point associated to the enrollment."
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the address. Used to derive the metered service point associated to the enrollment."
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment."
        }
    }
}

Nested Schema : programInfo

Type: object

Show Source

• cisServiceAgreementId: string
  Maximum Length: 12

  The CIS Service Agreement ID associated to the metered service. Optional.
• programCode: string
  Maximum Length: 120

  Program Code of the program being enrolled
• startDate: string (date)
  The desired application date of the enrollment.

{
    "type":"object",
    "properties":{
        "cisServiceAgreementId":{
            "type":"string",
            "maxLength":12,
            "description":"The CIS Service Agreement ID associated to the metered service. Optional."
        },
        "programCode":{
            "type":"string",
            "maxLength":120,
            "description":"Program Code of the program being enrolled"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The desired application date of the enrollment."
        }
    }
}

Nested Schema : assetList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":0,
                "description":"Sequence"
            },
            "assetId":{
                "type":"string",
                "maxLength":12,
                "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional."
            },
            "specification":{
                "type":"string",
                "maxLength":30,
                "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
            },
            "assetType":{
                "type":"string",
                "maxLength":30,
                "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
            },
            "badgeNo":{
                "type":"string",
                "maxLength":60,
                "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
            },
            "serialNo":{
                "type":"string",
                "maxLength":60,
                "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
            },
            "nicId":{
                "type":"string",
                "maxLength":100,
                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
            },
            "headEndSystem":{
                "type":"string",
                "maxLength":30,
                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• assetId: string
  Maximum Length: 12

  Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional.
• assetType: string
  Maximum Length: 30

  Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record.
• badgeNo: string
  Maximum Length: 60

  Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments.
• headEndSystem: string
  Maximum Length: 30

  Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record.
• nicId: string
  Maximum Length: 100

  Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record.
• sequence: number
  Minimum Value: 0

  Maximum Value: 999

  Sequence
• serialNo: string
  Maximum Length: 60

  Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments.
• specification: string
  Maximum Length: 30

  Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record.

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":0,
            "description":"Sequence"
        },
        "assetId":{
            "type":"string",
            "maxLength":12,
            "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional."
        },
        "specification":{
            "type":"string",
            "maxLength":30,
            "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
        },
        "assetType":{
            "type":"string",
            "maxLength":30,
            "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
        },
        "badgeNo":{
            "type":"string",
            "maxLength":60,
            "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
        },
        "serialNo":{
            "type":"string",
            "maxLength":60,
            "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
        },
        "nicId":{
            "type":"string",
            "maxLength":100,
            "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
        },
        "headEndSystem":{
            "type":"string",
            "maxLength":30,
            "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• assetInfo: object assetInfo
• customerInfo: object customerInfo
• locationInfo: object locationInfo
• programInfo: object programInfo

{
    "type":"object",
    "properties":{
        "customerInfo":{
            "type":"object",
            "properties":{
                "cisPersonId":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
                },
                "cisAccountId":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
                },
                "name":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
                },
                "homePhone":{
                    "type":"string",
                    "maxLength":24,
                    "description":"Phone Number"
                },
                "businessPhone":{
                    "type":"string",
                    "maxLength":24,
                    "description":"Phone Number"
                },
                "contactNumber":{
                    "type":"string",
                    "maxLength":24,
                    "description":"Phone Number"
                },
                "email":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
                }
            }
        },
        "programInfo":{
            "type":"object",
            "properties":{
                "cisServiceAgreementId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The CIS Service Agreement ID associated to the metered service. Optional."
                },
                "programCode":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Program Code of the program being enrolled"
                },
                "startDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The desired application date of the enrollment."
                }
            }
        },
        "locationInfo":{
            "type":"object",
            "properties":{
                "cisPremiseId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
                },
                "cisServicePointID":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
                },
                "division":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Division is used to define the jurisdiction in which the customer is located."
                },
                "timeZone":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Time Zone"
                },
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"The country of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment."
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The city of the address. Used to derive the metered service point associated to the enrollment."
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The county of the address. Used to derive the metered service point associated to the enrollment."
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the address. Used to derive the metered service point associated to the enrollment."
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment."
                }
            }
        },
        "assetInfo":{
            "type":"object",
            "properties":{
                "installationMethod":{
                    "type":"string",
                    "enum":[
                        "X1RE",
                        "X1SD",
                        "X1SI",
                        "X1UI"
                    ],
                    "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `X1RE` - Re-enroll,\n* `X1SD` - Ship Device,\n* `X1SI` - Bring Your Own,\n* `X1UI` - Utility Installation"
                },
                "assetOwnership":{
                    "type":"string",
                    "enum":[
                        "W1CO",
                        "W1OW"
                    ],
                    "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned"
                },
                "assetList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":0,
                                "description":"Sequence"
                            },
                            "assetId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional."
                            },
                            "specification":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                            },
                            "assetType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                            },
                            "badgeNo":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
                            },
                            "serialNo":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
                            },
                            "nicId":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                            },
                            "headEndSystem":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1DAAdEnroll"
    }
}

Nested Schema : assetInfo

Type: object

Show Source

• assetList: array assetList
• assetOwnership: string
  Allowed Values: [ "W1CO", "W1OW" ]

  Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location. * `W1CO` - Customer Owned, * `W1OW` - Utility Owned
• installationMethod: string
  Allowed Values: [ "X1RE", "X1SD", "X1SI", "X1UI" ]

  Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location. * `X1RE` - Re-enroll, * `X1SD` - Ship Device, * `X1SI` - Bring Your Own, * `X1UI` - Utility Installation

{
    "type":"object",
    "properties":{
        "installationMethod":{
            "type":"string",
            "enum":[
                "X1RE",
                "X1SD",
                "X1SI",
                "X1UI"
            ],
            "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `X1RE` - Re-enroll,\n* `X1SD` - Ship Device,\n* `X1SI` - Bring Your Own,\n* `X1UI` - Utility Installation"
        },
        "assetOwnership":{
            "type":"string",
            "enum":[
                "W1CO",
                "W1OW"
            ],
            "description":"Installation method, along with asset ownership, is used to determine device setup actions to perform during the enrollment. For Bring Your Own (installation method), Customer Owned (asset ownership) enrollments, details of the controllable device (specification, asset type, NIC Id, head end system) must be provided for the enrollment process to create the device record and attach it to the device location.\n* `W1CO` - Customer Owned,\n* `W1OW` - Utility Owned"
        },
        "assetList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":0,
                        "description":"Sequence"
                    },
                    "assetId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional."
                    },
                    "specification":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                    },
                    "assetType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                    },
                    "badgeNo":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
                    },
                    "serialNo":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
                    },
                    "nicId":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                    },
                    "headEndSystem":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
                    }
                }
            }
        }
    }
}

Nested Schema : customerInfo

Type: object

Show Source

• businessPhone: string
  Maximum Length: 24

  Phone Number
• cisAccountId: string
  Maximum Length: 30

  The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided.
• cisPersonId: string
  Maximum Length: 30

  The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided.
• contactNumber: string
  Maximum Length: 24

  Phone Number
• email: string
  Maximum Length: 254

  The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
• homePhone: string
  Maximum Length: 24

  Phone Number
• name: string
  Maximum Length: 254

  The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment.

{
    "type":"object",
    "properties":{
        "cisPersonId":{
            "type":"string",
            "maxLength":30,
            "description":"The CIS Person Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
        },
        "cisAccountId":{
            "type":"string",
            "maxLength":30,
            "description":"The CIS Account Id associated to the metered service point. Used to derive the existing customer and metered service record associated to the enrollment. Optional, if name is provided."
        },
        "name":{
            "type":"string",
            "maxLength":254,
            "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        },
        "homePhone":{
            "type":"string",
            "maxLength":24,
            "description":"Phone Number"
        },
        "businessPhone":{
            "type":"string",
            "maxLength":24,
            "description":"Phone Number"
        },
        "contactNumber":{
            "type":"string",
            "maxLength":24,
            "description":"Phone Number"
        },
        "email":{
            "type":"string",
            "maxLength":254,
            "description":"The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        }
    }
}

Nested Schema : locationInfo

Type: object

Show Source

• address1: string
  Maximum Length: 254

  The first line of the address. Used to derive the metered service point associated to the enrollment.
• address2: string
  Maximum Length: 254

  The second line of the address. Used to derive the metered service point associated to the enrollment.
• address3: string
  Maximum Length: 254

  The third line of the address. Used to derive the metered service point associated to the enrollment.
• address4: string
  Maximum Length: 254

  The fourth line of the address. Used to derive the metered service point associated to the enrollment.
• cisPremiseId: string
  Maximum Length: 60

  The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided.
• cisServicePointID: string
  Maximum Length: 60

  The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided.
• city: string
  Maximum Length: 90

  The city of the address. Used to derive the metered service point associated to the enrollment.
• country: string
  Maximum Length: 3

  The country of the address. Used to derive the metered service point associated to the enrollment.
• county: string
  Maximum Length: 90

  The county of the address. Used to derive the metered service point associated to the enrollment.
• division: string
  Maximum Length: 30

  Division is used to define the jurisdiction in which the customer is located.
• postal: string
  Maximum Length: 12

  The postal code of the address. Used to derive the metered service point associated to the enrollment.
• state: string
  Maximum Length: 6

  The state of the address. Used to derive the metered service point associated to the enrollment.
• timeZone: string
  Maximum Length: 10

  Time Zone

{
    "type":"object",
    "properties":{
        "cisPremiseId":{
            "type":"string",
            "maxLength":60,
            "description":"The CIS Premise Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
        },
        "cisServicePointID":{
            "type":"string",
            "maxLength":60,
            "description":"The CIS Service Point Id associated to the metered service point. Used to derive the metered service point associated to the enrollment. Optional, if address information is provided."
        },
        "division":{
            "type":"string",
            "maxLength":30,
            "description":"Division is used to define the jurisdiction in which the customer is located."
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Time Zone"
        },
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"The country of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the address. Used to derive the metered service point associated to the enrollment."
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the address. Used to derive the metered service point associated to the enrollment."
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the address. Used to derive the metered service point associated to the enrollment."
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment."
        }
    }
}

Nested Schema : programInfo

Type: object

Show Source

• cisServiceAgreementId: string
  Maximum Length: 12

  The CIS Service Agreement ID associated to the metered service. Optional.
• programCode: string
  Maximum Length: 120

  Program Code of the program being enrolled
• startDate: string (date)
  The desired application date of the enrollment.

{
    "type":"object",
    "properties":{
        "cisServiceAgreementId":{
            "type":"string",
            "maxLength":12,
            "description":"The CIS Service Agreement ID associated to the metered service. Optional."
        },
        "programCode":{
            "type":"string",
            "maxLength":120,
            "description":"Program Code of the program being enrolled"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The desired application date of the enrollment."
        }
    }
}

Nested Schema : assetList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":0,
                "description":"Sequence"
            },
            "assetId":{
                "type":"string",
                "maxLength":12,
                "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional."
            },
            "specification":{
                "type":"string",
                "maxLength":30,
                "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
            },
            "assetType":{
                "type":"string",
                "maxLength":30,
                "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
            },
            "badgeNo":{
                "type":"string",
                "maxLength":60,
                "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
            },
            "serialNo":{
                "type":"string",
                "maxLength":60,
                "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
            },
            "nicId":{
                "type":"string",
                "maxLength":100,
                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
            },
            "headEndSystem":{
                "type":"string",
                "maxLength":30,
                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• assetId: string
  Maximum Length: 12

  Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional.
• assetType: string
  Maximum Length: 30

  Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record.
• badgeNo: string
  Maximum Length: 60

  Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments.
• headEndSystem: string
  Maximum Length: 30

  Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record.
• nicId: string
  Maximum Length: 100

  Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record.
• sequence: number
  Minimum Value: 0

  Maximum Value: 999

  Sequence
• serialNo: string
  Maximum Length: 60

  Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments.
• specification: string
  Maximum Length: 30

  Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record.

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":0,
            "description":"Sequence"
        },
        "assetId":{
            "type":"string",
            "maxLength":12,
            "description":"Asset Id, mostly specific to Utility Owned devices, will be derived internally based on the other Asset Details provided in the request. Optional."
        },
        "specification":{
            "type":"string",
            "maxLength":30,
            "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
        },
        "assetType":{
            "type":"string",
            "maxLength":30,
            "description":"Specification, along with the asset type, is used to to define the type of controllable device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
        },
        "badgeNo":{
            "type":"string",
            "maxLength":60,
            "description":"Badge number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
        },
        "serialNo":{
            "type":"string",
            "maxLength":60,
            "description":"Serial number of the controllable device. This value is optional; when provided, this value is recorded on the controllable device record for bring your own device enrollments."
        },
        "nicId":{
            "type":"string",
            "maxLength":100,
            "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
        },
        "headEndSystem":{
            "type":"string",
            "maxLength":30,
            "description":"Head end system, along with the NIC Id, is used to uniquely identify the device. For customer owned devices, these values are required for the enrollment process to create the controllable device record."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1DAAdEnroll

Type: object

Show Source

• exception: object exception
• serviceTaskId: string
  Maximum Length: 14

  Service Task ID
• status: string
  Maximum Length: 12

  Status of the program enrollment based on business object lifecycle.

{
    "type":"object",
    "properties":{
        "serviceTaskId":{
            "type":"string",
            "maxLength":14,
            "description":"Service Task ID"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the program enrollment based on business object lifecycle."
        },
        "exception":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"string",
                    "maxLength":5,
                    "description":"Message Category"
                },
                "messageNumber":{
                    "type":"string",
                    "maxLength":5,
                    "description":"Message Number"
                },
                "expandedMessage":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Expanded message parameter"
                }
            }
        }
    },
    "xml":{
        "name":"X1DAAdEnroll"
    }
}

Nested Schema : exception

Type: object

Show Source

• expandedMessage: string
  Maximum Length: 60

  Expanded message parameter
• messageCategory: string
  Maximum Length: 5

  Message Category
• messageNumber: string
  Maximum Length: 5

  Message Number

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"string",
            "maxLength":5,
            "description":"Message Category"
        },
        "messageNumber":{
            "type":"string",
            "maxLength":5,
            "description":"Message Number"
        },
        "expandedMessage":{
            "type":"string",
            "maxLength":60,
            "description":"Expanded message parameter"
        }
    }
}

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