Jump to

• Request
• Response

DER Interconnection

post

https://server:port/rest/apis/cross/digitalAssets/derDeviceManagement/interconnect

This REST web service allows the recording of interconnection details of a Distributed Energy Resources (DER) device.

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
• transactionId: string
  Maximum Length: 120

  External Transaction ID

{
    "type":"object",
    "properties":{
        "transactionId":{
            "type":"string",
            "maxLength":"120",
            "description":"External Transaction ID"
        },
        "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. 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. 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"
                },
                "homePhone":{
                    "type":"string",
                    "maxLength":"24",
                    "description":"The home phone of the customer. Used to derive the existing customer and metered service record"
                },
                "businessPhone":{
                    "type":"string",
                    "maxLength":"24",
                    "description":"The business phone of the customer. Used to derive the existing customer and metered service record"
                },
                "email":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The email address of the customer. Used to derive the existing customer and metered service record"
                }
            }
        },
        "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.  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. 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":"The time zone of the address"
                },
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"The country of the address. Used to derive the metered service point"
                },
                "address1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The first line of the address. Used to derive the metered service point"
                },
                "address2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The second line of the address. Used to derive the metered service point"
                },
                "address3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The third line of the address. Used to derive the metered service point"
                },
                "address4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The fourth line of the address. Used to derive the metered service point"
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The city of the address. Used to derive the metered service point"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The county of the address. Used to derive the metered service point"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"The state of the address. Used to derive the metered service point"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"The postal code of the address. Used to derive the metered service point"
                }
            }
        },
        "assetInfo":{
            "type":"object",
            "properties":{
                "manufacturer":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Manufacturer"
                },
                "model":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Model"
                },
                "serialNo":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Serial number"
                },
                "interconnectionAttributes":{
                    "type":"object",
                    "properties":{
                        "interconnectionAttributesList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "attribute":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Interconnection attribute name"
                                    },
                                    "value":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Interconnection attribute value"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1_DERIntCon"
    }
}

Nested Schema : assetInfo

Type: object

Show Source

• interconnectionAttributes: object interconnectionAttributes
• manufacturer: string
  Maximum Length: 30

  Manufacturer
• model: string
  Maximum Length: 30

  Model
• serialNo: string
  Maximum Length: 60

  Serial number

{
    "type":"object",
    "properties":{
        "manufacturer":{
            "type":"string",
            "maxLength":"30",
            "description":"Manufacturer"
        },
        "model":{
            "type":"string",
            "maxLength":"30",
            "description":"Model"
        },
        "serialNo":{
            "type":"string",
            "maxLength":"60",
            "description":"Serial number"
        },
        "interconnectionAttributes":{
            "type":"object",
            "properties":{
                "interconnectionAttributesList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "attribute":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Interconnection attribute name"
                            },
                            "value":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Interconnection attribute value"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : customerInfo

Type: object

Show Source

• businessPhone: string
  Maximum Length: 24

  The business phone of the customer. Used to derive the existing customer and metered service record
• 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. 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. Optional, if name is provided.
• email: string
  Maximum Length: 254

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

  The home phone of the customer. Used to derive the existing customer and metered service record
• name: string
  Maximum Length: 254

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

{
    "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. 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. 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"
        },
        "homePhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The home phone of the customer. Used to derive the existing customer and metered service record"
        },
        "businessPhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The business phone of the customer. Used to derive the existing customer and metered service record"
        },
        "email":{
            "type":"string",
            "maxLength":"254",
            "description":"The email address of the customer. Used to derive the existing customer and metered service record"
        }
    }
}

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

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

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

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

  The CIS Premise Id associated to the metered service point. Used to derive the metered service point. 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. Optional, if address information is provided.
• city: string
  Maximum Length: 90

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

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

  The county of the address. Used to derive the metered service point
• 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
• state: string
  Maximum Length: 6

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

  The time zone of the address

{
    "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.  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. 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":"The time zone of the address"
        },
        "country":{
            "type":"string",
            "maxLength":"3",
            "description":"The country of the address. Used to derive the metered service point"
        },
        "address1":{
            "type":"string",
            "maxLength":"254",
            "description":"The first line of the address. Used to derive the metered service point"
        },
        "address2":{
            "type":"string",
            "maxLength":"254",
            "description":"The second line of the address. Used to derive the metered service point"
        },
        "address3":{
            "type":"string",
            "maxLength":"254",
            "description":"The third line of the address. Used to derive the metered service point"
        },
        "address4":{
            "type":"string",
            "maxLength":"254",
            "description":"The fourth line of the address. Used to derive the metered service point"
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"The city of the address. Used to derive the metered service point"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"The county of the address. Used to derive the metered service point"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"The state of the address. Used to derive the metered service point"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"The postal code of the address. Used to derive the metered service point"
        }
    }
}

Nested Schema : interconnectionAttributes

Type: object

Show Source

• interconnectionAttributesList: array interconnectionAttributesList

{
    "type":"object",
    "properties":{
        "interconnectionAttributesList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "attribute":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Interconnection attribute name"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Interconnection attribute value"
                    }
                }
            }
        }
    }
}

Nested Schema : interconnectionAttributesList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "attribute":{
                "type":"string",
                "maxLength":"254",
                "description":"Interconnection attribute name"
            },
            "value":{
                "type":"string",
                "maxLength":"254",
                "description":"Interconnection attribute value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• attribute: string
  Maximum Length: 254

  Interconnection attribute name
• value: string
  Maximum Length: 254

  Interconnection attribute value

{
    "type":"object",
    "properties":{
        "attribute":{
            "type":"string",
            "maxLength":"254",
            "description":"Interconnection attribute name"
        },
        "value":{
            "type":"string",
            "maxLength":"254",
            "description":"Interconnection attribute value"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• assetInfo: object assetInfo
• customerInfo: object customerInfo
• locationInfo: object locationInfo
• transactionId: string
  Maximum Length: 120

  External Transaction ID

{
    "type":"object",
    "properties":{
        "transactionId":{
            "type":"string",
            "maxLength":"120",
            "description":"External Transaction ID"
        },
        "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. 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. 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"
                },
                "homePhone":{
                    "type":"string",
                    "maxLength":"24",
                    "description":"The home phone of the customer. Used to derive the existing customer and metered service record"
                },
                "businessPhone":{
                    "type":"string",
                    "maxLength":"24",
                    "description":"The business phone of the customer. Used to derive the existing customer and metered service record"
                },
                "email":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The email address of the customer. Used to derive the existing customer and metered service record"
                }
            }
        },
        "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.  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. 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":"The time zone of the address"
                },
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"The country of the address. Used to derive the metered service point"
                },
                "address1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The first line of the address. Used to derive the metered service point"
                },
                "address2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The second line of the address. Used to derive the metered service point"
                },
                "address3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The third line of the address. Used to derive the metered service point"
                },
                "address4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The fourth line of the address. Used to derive the metered service point"
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The city of the address. Used to derive the metered service point"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The county of the address. Used to derive the metered service point"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"The state of the address. Used to derive the metered service point"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"The postal code of the address. Used to derive the metered service point"
                }
            }
        },
        "assetInfo":{
            "type":"object",
            "properties":{
                "manufacturer":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Manufacturer"
                },
                "model":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Model"
                },
                "serialNo":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Serial number"
                },
                "interconnectionAttributes":{
                    "type":"object",
                    "properties":{
                        "interconnectionAttributesList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "attribute":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Interconnection attribute name"
                                    },
                                    "value":{
                                        "type":"string",
                                        "maxLength":"254",
                                        "description":"Interconnection attribute value"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1_DERIntCon"
    }
}

Nested Schema : assetInfo

Type: object

Show Source

• interconnectionAttributes: object interconnectionAttributes
• manufacturer: string
  Maximum Length: 30

  Manufacturer
• model: string
  Maximum Length: 30

  Model
• serialNo: string
  Maximum Length: 60

  Serial number

{
    "type":"object",
    "properties":{
        "manufacturer":{
            "type":"string",
            "maxLength":"30",
            "description":"Manufacturer"
        },
        "model":{
            "type":"string",
            "maxLength":"30",
            "description":"Model"
        },
        "serialNo":{
            "type":"string",
            "maxLength":"60",
            "description":"Serial number"
        },
        "interconnectionAttributes":{
            "type":"object",
            "properties":{
                "interconnectionAttributesList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "attribute":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Interconnection attribute name"
                            },
                            "value":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Interconnection attribute value"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : customerInfo

Type: object

Show Source

• businessPhone: string
  Maximum Length: 24

  The business phone of the customer. Used to derive the existing customer and metered service record
• 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. 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. Optional, if name is provided.
• email: string
  Maximum Length: 254

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

  The home phone of the customer. Used to derive the existing customer and metered service record
• name: string
  Maximum Length: 254

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

{
    "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. 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. 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"
        },
        "homePhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The home phone of the customer. Used to derive the existing customer and metered service record"
        },
        "businessPhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The business phone of the customer. Used to derive the existing customer and metered service record"
        },
        "email":{
            "type":"string",
            "maxLength":"254",
            "description":"The email address of the customer. Used to derive the existing customer and metered service record"
        }
    }
}

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

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

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

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

  The CIS Premise Id associated to the metered service point. Used to derive the metered service point. 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. Optional, if address information is provided.
• city: string
  Maximum Length: 90

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

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

  The county of the address. Used to derive the metered service point
• 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
• state: string
  Maximum Length: 6

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

  The time zone of the address

{
    "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.  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. 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":"The time zone of the address"
        },
        "country":{
            "type":"string",
            "maxLength":"3",
            "description":"The country of the address. Used to derive the metered service point"
        },
        "address1":{
            "type":"string",
            "maxLength":"254",
            "description":"The first line of the address. Used to derive the metered service point"
        },
        "address2":{
            "type":"string",
            "maxLength":"254",
            "description":"The second line of the address. Used to derive the metered service point"
        },
        "address3":{
            "type":"string",
            "maxLength":"254",
            "description":"The third line of the address. Used to derive the metered service point"
        },
        "address4":{
            "type":"string",
            "maxLength":"254",
            "description":"The fourth line of the address. Used to derive the metered service point"
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"The city of the address. Used to derive the metered service point"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"The county of the address. Used to derive the metered service point"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"The state of the address. Used to derive the metered service point"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"The postal code of the address. Used to derive the metered service point"
        }
    }
}

Nested Schema : interconnectionAttributes

Type: object

Show Source

• interconnectionAttributesList: array interconnectionAttributesList

{
    "type":"object",
    "properties":{
        "interconnectionAttributesList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "attribute":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Interconnection attribute name"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Interconnection attribute value"
                    }
                }
            }
        }
    }
}

Nested Schema : interconnectionAttributesList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "attribute":{
                "type":"string",
                "maxLength":"254",
                "description":"Interconnection attribute name"
            },
            "value":{
                "type":"string",
                "maxLength":"254",
                "description":"Interconnection attribute value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• attribute: string
  Maximum Length: 254

  Interconnection attribute name
• value: string
  Maximum Length: 254

  Interconnection attribute value

{
    "type":"object",
    "properties":{
        "attribute":{
            "type":"string",
            "maxLength":"254",
            "description":"Interconnection attribute name"
        },
        "value":{
            "type":"string",
            "maxLength":"254",
            "description":"Interconnection attribute value"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1_DERIntCon

Type: object

Show Source

• enrollmentId: string
  Maximum Length: 4

  Enrollment ID
• exception: object exception
• status: string
  Maximum Length: 12

  Status
• transactionId: string
  Maximum Length: 120

  External Transaction ID

{
    "type":"object",
    "properties":{
        "enrollmentId":{
            "type":"string",
            "maxLength":"4",
            "description":"Enrollment ID"
        },
        "transactionId":{
            "type":"string",
            "maxLength":"120",
            "description":"External Transaction ID"
        },
        "status":{
            "type":"string",
            "maxLength":"12",
            "description":"Status"
        },
        "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":"X1_DERIntCon"
    }
}

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