Get Program Unenrollment

get

/rest/apis/cross/digitalAssets/programEnrollments/unenroll/{Unenrollment Id}

This operation retrieves a customer's program unenrollment request status.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : X1-DAUnenrol
Type: object
Show Source
Nested Schema : appointmentSlots
Type: object
Show Source
Nested Schema : assetInfo
Type: object
Show Source
  • 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
  • Allowed Values: [ "X1KP", "X1SD", "X1UR" ]
    Removal Method: * `X1KP` - Keep, * `X1SD` - Ship Device, * `X1UR` - Utility Removal
Nested Schema : customerInfo
Type: object
Show Source
  • Maximum Length: 24
    The business phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
  • 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.
  • 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.
  • Maximum Length: 254
    The email address of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
  • Maximum Length: 24
    The home phone of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
  • Maximum Length: 254
    The name of the customer. Used to derive the existing customer and metered service record associated to the enrollment.
Nested Schema : deviceSetup
Type: object
Show Source
Nested Schema : exception
Type: object
Show Source
Nested Schema : locationInfo
Type: object
Show Source
  • Maximum Length: 254
    The first line of the address. Used to derive the metered service point associated to the enrollment.
  • Maximum Length: 254
    The second line of the address. Used to derive the metered service point associated to the enrollment.
  • Maximum Length: 254
    The third line of the address. Used to derive the metered service point associated to the enrollment.
  • Maximum Length: 254
    The fourth line of the address. Used to derive the metered service point associated to the enrollment.
  • 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.
  • 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.
  • Maximum Length: 90
    The city of the address. Used to derive the metered service point associated to the enrollment.
  • Maximum Length: 3
    The country of the address. Used to derive the metered service point associated to the enrollment.
  • Maximum Length: 90
    The county of the address. Used to derive the metered service point associated to the enrollment.
  • Maximum Length: 30
    Division is used to define the jurisdiction in which the customer is located.
  • Maximum Length: 12
    The postal code of the address. Used to derive the metered service point associated to the enrollment.
  • Maximum Length: 6
    The state of the address. Used to derive the metered service point associated to the enrollment.
  • Maximum Length: 10
    Time Zone
Nested Schema : programInfo
Type: object
Show Source
Nested Schema : relatedObjects
Type: object
Show Source
  • Maximum Length: 12
    A unique identifier associated to the customer contact within the system.
  • Maximum Length: 12
    A unique identifier associated to a device location within the system.
  • Maximum Length: 12
    A unique identifier associated to a program subscription within the system.
Nested Schema : crewShiftList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : deviceSetupActionsList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 14
    Activity
  • Maximum Length: 30
    Activity Type defines the main attributes for activities of a certain type and acts as a model and template for activity records.
  • Allowed Values: [ "ZZ_TEST_METERINSPECT", "ZZ-Meter Inspection", "ZZ_Appnt_Field_Typ", "D1-DisconnectItemSPAtSource", "D1-ConnectSPAtSourceAndTurnOn", "D1-DisconnectSPAtSource", "ZZ-InstallMeter", "D1-ExchangeMeter", "ZZ-OdmAndSomDup", "ZZ-SomAndOdm4", "D1-DisConnSPAtDvcAndRmveDvc", "D1-TurnOffItem", "ZZ-TrimTree", "D1-ConnSPAtSrceAndInstMtr", "D1-TurnOnMeter", "D1-DisConnSPAtSrceAndRmveMtr", "D1-ReconnectItemforPayment", "D1-TurnOffMeter", "ZZ-SomAndOdm5", "ZZ-SomAndOdm6", "D1-DisconnectSPAtDevice", "ZZ-MeterInspection", "D1-InstallDevice", "ZZSSFTT4", "D1-ConnSPAtDvcAndInstDvc", "ZZPO_TestSOMEI", "ZZSSFTT3", "ZZSSFTT2", "D1-ConnectSPAtSource", "D1-DisconnectSPAtMeter", "ZZ-OdmAndSom15", "D1-ServiceInvestigation", "D1-DisConnSPAtMtrAndRmveMtr", "ZZ-MnlDemo1", "ZZ-ODMandSOM", "ZZ-MnlDemo4", "ZZ-MnlDemo3", "X1-InvestigateControllableDevice", "ZZ-MnlDemo7", "D1-ConnectSPAtSourceAndInstallMeter", "D1-RemoveDevice", "D1-ExchangeDevice", "X1-InstallControllableDevice", "ZZ-Meter Inspection-2", "D1-DisconnectWarning", "D1-MaintainEquipment", "ZZ-FaTypKK", "ZZSAFTT", "ZZ-TestDevice", "D1-CutForNonPayment", "ZZ-MaintainFireHydrant", "ZZ_Mgmt_FieldTskTyp", "D1-ConnectSPAtMeterAndTurnOn", "ZZ_HC_Field_task_type", "D1-ConnectSPAtDevice", "ZZ-OdmAndSom3", "ZZSAFTT_2", "ZZ-OdmAndSom2", "ZZPO-SOMACTTYP", "D1-ConnSPAtSrceAndTurnOnDvc", "D1-TurnOnPilotLight", "ZZ-ExchangeMeter", "ZZYC_MeterInspection", "D1-ConnSPAtSrceAndInstDvc", "D1-ConnectSPAtMeter", "ZZ-BookAppnt", "ZZAT-TrimTree", "D1-InstallMeter", "D1-ReconnectForPayment", "D1-ConnectSPAtDvcAndTurnOn", "D1-TrimTree", "ZZLJP_TEST", "D1-ConnSPAtMtrAndInstMtr", "ZZ-ReadMeter", "D1-CutItemForNonPayment", "D1-RemoveMeter", "D1-TurnOnItem", "D1-ReadMeter", "ZZ-OdmAndSom8", "ZZ-OdmAndSom7", "ZZ_CPS_FIELD_TASK_TYPE" ]
    Field Task Type: * `X1-InvestigateControllableDevice` - Investigate Controllable Device, * `X1-InstallControllableDevice` - Install Controllable Device * `ZZ_TEST_METERINSPECT` - 00ZZ_TEST_METERINSPECT, * `ZZ-Meter Inspection` - ZZ PO ODM and SOM, * `ZZ_Appnt_Field_Typ` - ZZ Field Task Type for Mgmt Appnt 1, * `D1-DisconnectItemSPAtSource` - Disconnect SP at Source Item, * `D1-ConnectSPAtSourceAndTurnOn` - Connect SP at Source and Turn On, * `D1-DisconnectSPAtSource` - Disconnect SP at Source, * `ZZ-InstallMeter` - ZZ - Install Meter, * `D1-ExchangeMeter` - Exchange Meter, * `ZZ-OdmAndSomDup` - ZZ ODM and SOM 3, * `ZZ-SomAndOdm4` - ZZ SOM and ODM 4 Test, * `D1-DisConnSPAtDvcAndRmveDvc` - Disconnect SP from Item and Remove Item, * `D1-TurnOffItem` - Turn Off Item, * `ZZ-TrimTree` - Trim Tree, * `D1-ConnSPAtSrceAndInstMtr` - Connect SP at Source and Install Meter, * `D1-TurnOnMeter` - Turn On Meter, * `D1-DisConnSPAtSrceAndRmveMtr` - Disconnect SP at Source and Remove Meter, * `D1-ReconnectItemforPayment` - Reconnect Item for Payment, * `D1-TurnOffMeter` - Turn Off Meter, * `ZZ-SomAndOdm5` - ZZ SOM and ODM 5, * `ZZ-SomAndOdm6` - ZZ SOM and ODM 6, * `D1-DisconnectSPAtDevice` - Disconnect SP from Item, * `ZZ-MeterInspection` - Meter Inspection, * `D1-InstallDevice` - Install Item, * `ZZSSFTT4` - ZZSSFTT4 - 1, * `D1-ConnSPAtDvcAndInstDvc` - Connect SP to Item and Install Item, * `ZZPO_TestSOMEI` - ZZPO_TestSOM Export-Import, * `ZZSSFTT3` - ZZSSFTT3, * `ZZSSFTT2` - ZZSSFTT2 - 5, * `D1-ConnectSPAtSource` - Connect SP at Source, * `D1-DisconnectSPAtMeter` - Disconnect SP at Meter, * `ZZ-OdmAndSom15` - ZZ ODM and SOM 15, * `D1-ServiceInvestigation` - Service Investigation, * `D1-DisConnSPAtMtrAndRmveMtr` - Disconnect SP at Meter and Remove Meter, * `ZZ-MnlDemo1` - ZZ Manila Demo 1, * `ZZ-ODMandSOM` - ZZ KPA ODM and SOM, * `ZZ-MnlDemo4` - ZZ Manila Demo 4 Edit, * `ZZ-MnlDemo3` - ZZ Manila Demo 3, * `X1-InvestigateControllableDevice` - Investigate Controllable Device, * `ZZ-MnlDemo7` - ZZ Manila Demo 7, * `D1-ConnectSPAtSourceAndInstallMeter` - Connect SP at Source and Install Meter, * `D1-RemoveDevice` - Remove Item, * `D1-ExchangeDevice` - Exchange Item, * `X1-InstallControllableDevice` - Install Controllable Device, * `ZZ-Meter Inspection-2` - ZZ PO ODM and SOM-2, * `D1-DisconnectWarning` - Disconnect Warning, * `D1-MaintainEquipment` - Maintain SP and Meter Equipment, * `ZZ-FaTypKK` - Test Field Task Type - KK, * `ZZSAFTT` - ZZSAFTT-1, * `ZZ-TestDevice` - Test Device, * `D1-CutForNonPayment` - Cut for Non Payment, * `ZZ-MaintainFireHydrant` - Inspect Communication Relay, * `ZZ_Mgmt_FieldTskTyp` - ZZ Field Task Type for Mgmt Appnt, * `D1-ConnectSPAtMeterAndTurnOn` - Connect SP at Meter and Turn On, * `ZZ_HC_Field_task_type` - ZZ_HC Field task type12 123456, * `D1-ConnectSPAtDevice` - Connect SP to Item, * `ZZ-OdmAndSom3` - ZZ ODM and SOM 3, * `ZZSAFTT_2` - ZZSAFTT-2, * `ZZ-OdmAndSom2` - ZZ ODM and SOM 2, * `ZZPO-SOMACTTYP` - ZZPO-SOMACTTYP, * `D1-ConnSPAtSrceAndTurnOnDvc` - Connect SP at Source and Turn On Item, * `D1-TurnOnPilotLight` - Turn On Pilot Light, * `ZZ-ExchangeMeter` - Exchange Meter ZZ, * `ZZYC_MeterInspection` - 00ZZYC_MeterInspection, * `D1-ConnSPAtSrceAndInstDvc` - Connect SP at Source and Install Item, * `D1-ConnectSPAtMeter` - Connect SP at Meter, * `ZZ-BookAppnt` - Test Book Appointment - KK, * `ZZAT-TrimTree` - Trim Tree, * `D1-InstallMeter` - Install Meter, * `D1-ReconnectForPayment` - Reconnect for Payment, * `D1-ConnectSPAtDvcAndTurnOn` - Connect SP to Item and Turn On, * `D1-TrimTree` - Trim Tree, * `ZZLJP_TEST` - ZZLJP_TEST, * `D1-ConnSPAtMtrAndInstMtr` - Connect SP at Meter and Install Meter, * `ZZ-ReadMeter` - ZZ Read Meter, * `D1-CutItemForNonPayment` - Cut Item for Non Payment, * `D1-RemoveMeter` - Remove Meter, * `D1-TurnOnItem` - Turn On Item, * `D1-ReadMeter` - Read Meter, * `ZZ-OdmAndSom8` - ZZ ODM and SOM 8, * `ZZ-OdmAndSom7` - ZZ ODM and SOM 7, * `ZZ_CPS_FIELD_TASK_TYPE` - CPS Field Task Type Test
  • Minimum Value: 0
    Maximum Value: 999
    Sequence
  • Allowed Values: [ "X1AC", "X1DC", "X1NA", "X1TD", "X1WO" ]
    Setup Action: * `X1AC` - Create Activity, * `X1DC` - Initiate Controllable Device Command, * `X1NA` - No Action Needed, * `X1TD` - Create To Do, * `X1WO` - Create Work Order
  • Maximum Length: 12
    A unique identifier of a work order used as template for generating work orders.
  • Maximum Length: 14
    To do entry refers to certain events that occur within the system and trigger messages describing work that requires attention.
  • Maximum Length: 10
    To Do Roles are assigned to users and are referenced by a to do entry created by the system.
  • Maximum Length: 8
    To Do Type refers to the categorization of certain events that occur within the system and trigger messages describing work that requires attention.
  • Maximum Length: 14
    A system generated unique identifier associated to each work order that is created.

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top