Jump to

• Request
• Response

Create Program Unenrollment

post

https://server:port/rest/apis/cross/digitalAssets/programEnrollments/unenroll

This REST web service processes a customer's unenrollment request from a program in Oracle Utilities Digital Asset Cloud Service.

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

• customerInfo: object UNENROLLPROGRAM_request_customerInfo
• locationInfo: object ENROLLPROGRAM_request_locationInfo
• transactionId: string
  Maximum Length: 120

  Unique external Transaction identifier created by the external source application (for example, Grid Edge Distributed Energy Resource Management System)
• unenrollReason: string
  Allowed Values: [ "LSSL", "CUSTOMEROPTOUT", "INACTIVESERVICE", "INELIGIBLERATE" ]

  Unenroll reason is used for capturing the reason for unenrolling the customer from the program.: * `LSSL` - Life Support / Sensitive Load, * `CUSTOMEROPTOUT` - Customer Initiated Opt-Out, * `INACTIVESERVICE` - Inactive Service, * `INELIGIBLERATE` - Ineligible Rate

{
    "type":"object",
    "properties":{
        "transactionId":{
            "maxLength":120,
            "type":"string",
            "description":"Unique external Transaction identifier created by the external source application (for example, Grid Edge Distributed Energy Resource Management System)"
        },
        "unenrollReason":{
            "type":"string",
            "description":"Unenroll reason is used for capturing the reason for unenrolling the customer from the program.:\n* `LSSL` - Life Support / Sensitive Load,\n* `CUSTOMEROPTOUT` - Customer Initiated Opt-Out,\n* `INACTIVESERVICE` - Inactive Service,\n* `INELIGIBLERATE` - Ineligible Rate",
            "enum":[
                "LSSL",
                "CUSTOMEROPTOUT",
                "INACTIVESERVICE",
                "INELIGIBLERATE"
            ]
        },
        "customerInfo":{
            "$ref":"#/components/schemas/UNENROLLPROGRAM_request_customerInfo"
        },
        "locationInfo":{
            "$ref":"#/components/schemas/ENROLLPROGRAM_request_locationInfo"
        }
    },
    "xml":{
        "name":"X1-DAUnenrol"
    }
}

Nested Schema : UNENROLLPROGRAM_request_customerInfo

Type: object

Show Source

• 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.
• 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":{
            "maxLength":30,
            "type":"string",
            "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":{
            "maxLength":30,
            "type":"string",
            "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":{
            "maxLength":254,
            "type":"string",
            "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        }
    }
}

Nested Schema : ENROLLPROGRAM_request_locationInfo

Type: object

Show Source

• address1: string
  Maximum Length: 254

  TThe 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: 14

  The CIS Premise Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided.
• cisServicePointID: string
  Maximum Length: 12

  The CIS Service Point Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is 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. This value is optional if address information is provided.
• 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. A utility name or acronym is commonly used for division, while state information can be used for utilities that operate across multiple regions.
• 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":{
            "maxLength":14,
            "type":"string",
            "description":"The CIS Premise Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided."
        },
        "cisServicePointID":{
            "maxLength":12,
            "type":"string",
            "description":"The CIS Service Point Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided."
        },
        "division":{
            "maxLength":30,
            "type":"string",
            "description":"Division is used to define the jurisdiction in which the customer is located. A utility name or acronym is commonly used for division, while state information can be used for utilities that operate across multiple regions. "
        },
        "timeZone":{
            "maxLength":10,
            "type":"string",
            "description":"Time Zone"
        },
        "country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the address. Used to derive the metered service point associated to the enrollment. This value is optional if address information is provided."
        },
        "address1":{
            "maxLength":254,
            "type":"string",
            "description":"TThe first line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address2":{
            "maxLength":254,
            "type":"string",
            "description":"The second line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address3":{
            "maxLength":254,
            "type":"string",
            "description":"The third line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address4":{
            "maxLength":254,
            "type":"string",
            "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "city":{
            "maxLength":90,
            "type":"string",
            "description":"The city of the address. Used to derive the metered service point associated to the enrollment."
        },
        "county":{
            "maxLength":90,
            "type":"string",
            "description":"The county of the address. Used to derive the metered service point associated to the enrollment."
        },
        "state":{
            "maxLength":6,
            "type":"string",
            "description":"The state of the address. Used to derive the metered service point associated to the enrollment."
        },
        "postal":{
            "maxLength":12,
            "type":"string",
            "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• customerInfo: object UNENROLLPROGRAM_request_customerInfo
• locationInfo: object ENROLLPROGRAM_request_locationInfo
• transactionId: string
  Maximum Length: 120

  Unique external Transaction identifier created by the external source application (for example, Grid Edge Distributed Energy Resource Management System)
• unenrollReason: string
  Allowed Values: [ "LSSL", "CUSTOMEROPTOUT", "INACTIVESERVICE", "INELIGIBLERATE" ]

  Unenroll reason is used for capturing the reason for unenrolling the customer from the program.: * `LSSL` - Life Support / Sensitive Load, * `CUSTOMEROPTOUT` - Customer Initiated Opt-Out, * `INACTIVESERVICE` - Inactive Service, * `INELIGIBLERATE` - Ineligible Rate

{
    "type":"object",
    "properties":{
        "transactionId":{
            "maxLength":120,
            "type":"string",
            "description":"Unique external Transaction identifier created by the external source application (for example, Grid Edge Distributed Energy Resource Management System)"
        },
        "unenrollReason":{
            "type":"string",
            "description":"Unenroll reason is used for capturing the reason for unenrolling the customer from the program.:\n* `LSSL` - Life Support / Sensitive Load,\n* `CUSTOMEROPTOUT` - Customer Initiated Opt-Out,\n* `INACTIVESERVICE` - Inactive Service,\n* `INELIGIBLERATE` - Ineligible Rate",
            "enum":[
                "LSSL",
                "CUSTOMEROPTOUT",
                "INACTIVESERVICE",
                "INELIGIBLERATE"
            ]
        },
        "customerInfo":{
            "$ref":"#/components/schemas/UNENROLLPROGRAM_request_customerInfo"
        },
        "locationInfo":{
            "$ref":"#/components/schemas/ENROLLPROGRAM_request_locationInfo"
        }
    },
    "xml":{
        "name":"X1-DAUnenrol"
    }
}

Nested Schema : UNENROLLPROGRAM_request_customerInfo

Type: object

Show Source

• 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.
• 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":{
            "maxLength":30,
            "type":"string",
            "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":{
            "maxLength":30,
            "type":"string",
            "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":{
            "maxLength":254,
            "type":"string",
            "description":"The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment."
        }
    }
}

Nested Schema : ENROLLPROGRAM_request_locationInfo

Type: object

Show Source

• address1: string
  Maximum Length: 254

  TThe 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: 14

  The CIS Premise Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided.
• cisServicePointID: string
  Maximum Length: 12

  The CIS Service Point Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is 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. This value is optional if address information is provided.
• 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. A utility name or acronym is commonly used for division, while state information can be used for utilities that operate across multiple regions.
• 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":{
            "maxLength":14,
            "type":"string",
            "description":"The CIS Premise Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided."
        },
        "cisServicePointID":{
            "maxLength":12,
            "type":"string",
            "description":"The CIS Service Point Id associated to the metered service point. This unique identifier is used to derive the metered service point associated to the enrollment. This value is optional if address information is provided."
        },
        "division":{
            "maxLength":30,
            "type":"string",
            "description":"Division is used to define the jurisdiction in which the customer is located. A utility name or acronym is commonly used for division, while state information can be used for utilities that operate across multiple regions. "
        },
        "timeZone":{
            "maxLength":10,
            "type":"string",
            "description":"Time Zone"
        },
        "country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the address. Used to derive the metered service point associated to the enrollment. This value is optional if address information is provided."
        },
        "address1":{
            "maxLength":254,
            "type":"string",
            "description":"TThe first line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address2":{
            "maxLength":254,
            "type":"string",
            "description":"The second line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address3":{
            "maxLength":254,
            "type":"string",
            "description":"The third line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "address4":{
            "maxLength":254,
            "type":"string",
            "description":"The fourth line of the address. Used to derive the metered service point associated to the enrollment."
        },
        "city":{
            "maxLength":90,
            "type":"string",
            "description":"The city of the address. Used to derive the metered service point associated to the enrollment."
        },
        "county":{
            "maxLength":90,
            "type":"string",
            "description":"The county of the address. Used to derive the metered service point associated to the enrollment."
        },
        "state":{
            "maxLength":6,
            "type":"string",
            "description":"The state of the address. Used to derive the metered service point associated to the enrollment."
        },
        "postal":{
            "maxLength":12,
            "type":"string",
            "description":"The postal code of the address. Used to derive the metered service point associated to the enrollment."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1-DAUnenrol

Type: object

Show Source

• exception: object ENROLLPROGRAM_response_exception
• status: string
  Maximum Length: 12

  Status of the Enrollment based on business object lifecycle.
• transactionId: string
  Maximum Length: 120

  External Transaction identifier created initially by the external source application (for example, Grid Edge Distributed Energy Resource Management System)
• unenrollmentId: string
  Maximum Length: 4

  Unenrollment identifier created by Oracle Utilities Digital Asset Cloud Service for each individual unenrollment record

{
    "type":"object",
    "properties":{
        "unenrollmentId":{
            "maxLength":4,
            "type":"string",
            "description":"Unenrollment identifier created by Oracle Utilities Digital Asset Cloud Service for each individual unenrollment record"
        },
        "transactionId":{
            "maxLength":120,
            "type":"string",
            "description":"External Transaction identifier created initially by the external source application (for example, Grid Edge Distributed Energy Resource Management System)"
        },
        "status":{
            "maxLength":12,
            "type":"string",
            "description":"Status of the Enrollment based on business object lifecycle."
        },
        "exception":{
            "$ref":"#/components/schemas/ENROLLPROGRAM_response_exception"
        }
    },
    "xml":{
        "name":"X1-DAUnenrol"
    }
}

Nested Schema : ENROLLPROGRAM_response_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":{
            "maxLength":5,
            "type":"string",
            "description":"Message Category"
        },
        "messageNumber":{
            "maxLength":5,
            "type":"string",
            "description":"Message Number"
        },
        "expandedMessage":{
            "maxLength":60,
            "type":"string",
            "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 problemDetailDocument_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":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_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":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "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 problemDetailDocument_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":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_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":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top