Jump to

• Request
• Response

Post Acknowledgement

post

/rest/apis/cross/digitalAssets/programEnrollments/postAcknowledgement

This operation returns the registration status of the controllable device with its head-end system.

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

• deviceHeadendStatus: object deviceHeadendStatus
• exceptionInfo: array exceptionInfo
• hasError: boolean
  Indicates whether incoming message has any error.

  Example: true
• syncRequestId: string
  Maximum Length: 14

  The system-generated unique identifier for the outbound sync request.

  Example: 15449036987849

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "maxLength":14,
            "description":"The system-generated unique identifier for the outbound sync request.",
            "example":"15449036987849"
        },
        "exceptionInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"A unique Sequence number is given to each entry after the information is saved.",
                        "example":"1"
                    },
                    "messageCategory":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Message Category within Oracle Utilities Application Framework.",
                        "example":"99999"
                    },
                    "messageNumber":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Message Number within Oracle Utilities Application Framework.",
                        "example":"99999"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Information from the customer.",
                        "example":"Device details not found."
                    },
                    "messageParameters":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "parameterSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"A unique Sequence number is given to each entry after the information is saved.",
                                    "example":"1"
                                },
                                "messageParameterValue":{
                                    "type":"string",
                                    "maxLength":2000,
                                    "description":"Message Parameter",
                                    "example":"Any string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "deviceHeadendStatus":{
            "type":"object",
            "properties":{
                "deviceHeadendStatusList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "deviceId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Device ID"
                            },
                            "headEndRegistration":{
                                "type":"string",
                                "enum":[
                                    "D1DR",
                                    "D1NR",
                                    "D1RE"
                                ],
                                "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
                                "example":"D1DR"
                            },
                            "message":{
                                "type":"string",
                                "maxLength":2000,
                                "description":"Message Information",
                                "example":"Invalid input."
                            }
                        }
                    }
                }
            }
        },
        "hasError":{
            "type":"boolean",
            "description":"Indicates whether incoming message has any error.",
            "example":"true"
        }
    },
    "xml":{
        "name":"X1DAPostAck"
    }
}

Nested Schema : deviceHeadendStatus

Type: object

Show Source

• deviceHeadendStatusList: array deviceHeadendStatusList

{
    "type":"object",
    "properties":{
        "deviceHeadendStatusList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deviceId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Device ID"
                    },
                    "headEndRegistration":{
                        "type":"string",
                        "enum":[
                            "D1DR",
                            "D1NR",
                            "D1RE"
                        ],
                        "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
                        "example":"D1DR"
                    },
                    "message":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Message Information",
                        "example":"Invalid input."
                    }
                }
            }
        }
    }
}

Nested Schema : exceptionInfo

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"A unique Sequence number is given to each entry after the information is saved.",
                "example":"1"
            },
            "messageCategory":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Message Category within Oracle Utilities Application Framework.",
                "example":"99999"
            },
            "messageNumber":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Message Number within Oracle Utilities Application Framework.",
                "example":"99999"
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Information from the customer.",
                "example":"Device details not found."
            },
            "messageParameters":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "parameterSequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"A unique Sequence number is given to each entry after the information is saved.",
                            "example":"1"
                        },
                        "messageParameterValue":{
                            "type":"string",
                            "maxLength":2000,
                            "description":"Message Parameter",
                            "example":"Any string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : deviceHeadendStatusList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deviceId":{
                "type":"string",
                "maxLength":12,
                "description":"Device ID"
            },
            "headEndRegistration":{
                "type":"string",
                "enum":[
                    "D1DR",
                    "D1NR",
                    "D1RE"
                ],
                "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
                "example":"D1DR"
            },
            "message":{
                "type":"string",
                "maxLength":2000,
                "description":"Message Information",
                "example":"Invalid input."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• deviceId: string
  Maximum Length: 12

  Device ID
• headEndRegistration: string
  Allowed Values: [ "D1DR", "D1NR", "D1RE" ]

  Head End Registration Status of the Device. * `D1DR` - Deregistered, * `D1NR` - Not Registered, * `D1RE` - Registered

  Example: D1DR
• message: string
  Maximum Length: 2000

  Message Information

  Example: Invalid input.

{
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID"
        },
        "headEndRegistration":{
            "type":"string",
            "enum":[
                "D1DR",
                "D1NR",
                "D1RE"
            ],
            "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
            "example":"D1DR"
        },
        "message":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Information",
            "example":"Invalid input."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Information from the customer.

  Example: Device details not found.
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category within Oracle Utilities Application Framework.

  Example: 99999
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.

  Example: 99999
• messageParameters: array messageParameters
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  A unique Sequence number is given to each entry after the information is saved.

  Example: 1

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"A unique Sequence number is given to each entry after the information is saved.",
            "example":"1"
        },
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Category within Oracle Utilities Application Framework.",
            "example":"99999"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework.",
            "example":"99999"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Information from the customer.",
            "example":"Device details not found."
        },
        "messageParameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parameterSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"A unique Sequence number is given to each entry after the information is saved.",
                        "example":"1"
                    },
                    "messageParameterValue":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Message Parameter",
                        "example":"Any string"
                    }
                }
            }
        }
    }
}

Nested Schema : messageParameters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parameterSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"A unique Sequence number is given to each entry after the information is saved.",
                "example":"1"
            },
            "messageParameterValue":{
                "type":"string",
                "maxLength":2000,
                "description":"Message Parameter",
                "example":"Any string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• messageParameterValue: string
  Maximum Length: 2000

  Message Parameter

  Example: Any string
• parameterSequence: number
  Minimum Value: -999

  Maximum Value: 999

  A unique Sequence number is given to each entry after the information is saved.

  Example: 1

{
    "type":"object",
    "properties":{
        "parameterSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"A unique Sequence number is given to each entry after the information is saved.",
            "example":"1"
        },
        "messageParameterValue":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter",
            "example":"Any string"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• deviceHeadendStatus: object deviceHeadendStatus
• exceptionInfo: array exceptionInfo
• hasError: boolean
  Indicates whether incoming message has any error.

  Example: true
• syncRequestId: string
  Maximum Length: 14

  The system-generated unique identifier for the outbound sync request.

  Example: 15449036987849

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "maxLength":14,
            "description":"The system-generated unique identifier for the outbound sync request.",
            "example":"15449036987849"
        },
        "exceptionInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"A unique Sequence number is given to each entry after the information is saved.",
                        "example":"1"
                    },
                    "messageCategory":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Message Category within Oracle Utilities Application Framework.",
                        "example":"99999"
                    },
                    "messageNumber":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Message Number within Oracle Utilities Application Framework.",
                        "example":"99999"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Information from the customer.",
                        "example":"Device details not found."
                    },
                    "messageParameters":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "parameterSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"A unique Sequence number is given to each entry after the information is saved.",
                                    "example":"1"
                                },
                                "messageParameterValue":{
                                    "type":"string",
                                    "maxLength":2000,
                                    "description":"Message Parameter",
                                    "example":"Any string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "deviceHeadendStatus":{
            "type":"object",
            "properties":{
                "deviceHeadendStatusList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "deviceId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Device ID"
                            },
                            "headEndRegistration":{
                                "type":"string",
                                "enum":[
                                    "D1DR",
                                    "D1NR",
                                    "D1RE"
                                ],
                                "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
                                "example":"D1DR"
                            },
                            "message":{
                                "type":"string",
                                "maxLength":2000,
                                "description":"Message Information",
                                "example":"Invalid input."
                            }
                        }
                    }
                }
            }
        },
        "hasError":{
            "type":"boolean",
            "description":"Indicates whether incoming message has any error.",
            "example":"true"
        }
    },
    "xml":{
        "name":"X1DAPostAck"
    }
}

Nested Schema : deviceHeadendStatus

Type: object

Show Source

• deviceHeadendStatusList: array deviceHeadendStatusList

{
    "type":"object",
    "properties":{
        "deviceHeadendStatusList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deviceId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Device ID"
                    },
                    "headEndRegistration":{
                        "type":"string",
                        "enum":[
                            "D1DR",
                            "D1NR",
                            "D1RE"
                        ],
                        "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
                        "example":"D1DR"
                    },
                    "message":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Message Information",
                        "example":"Invalid input."
                    }
                }
            }
        }
    }
}

Nested Schema : exceptionInfo

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"A unique Sequence number is given to each entry after the information is saved.",
                "example":"1"
            },
            "messageCategory":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Message Category within Oracle Utilities Application Framework.",
                "example":"99999"
            },
            "messageNumber":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Message Number within Oracle Utilities Application Framework.",
                "example":"99999"
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Information from the customer.",
                "example":"Device details not found."
            },
            "messageParameters":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "parameterSequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"A unique Sequence number is given to each entry after the information is saved.",
                            "example":"1"
                        },
                        "messageParameterValue":{
                            "type":"string",
                            "maxLength":2000,
                            "description":"Message Parameter",
                            "example":"Any string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : deviceHeadendStatusList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deviceId":{
                "type":"string",
                "maxLength":12,
                "description":"Device ID"
            },
            "headEndRegistration":{
                "type":"string",
                "enum":[
                    "D1DR",
                    "D1NR",
                    "D1RE"
                ],
                "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
                "example":"D1DR"
            },
            "message":{
                "type":"string",
                "maxLength":2000,
                "description":"Message Information",
                "example":"Invalid input."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• deviceId: string
  Maximum Length: 12

  Device ID
• headEndRegistration: string
  Allowed Values: [ "D1DR", "D1NR", "D1RE" ]

  Head End Registration Status of the Device. * `D1DR` - Deregistered, * `D1NR` - Not Registered, * `D1RE` - Registered

  Example: D1DR
• message: string
  Maximum Length: 2000

  Message Information

  Example: Invalid input.

{
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID"
        },
        "headEndRegistration":{
            "type":"string",
            "enum":[
                "D1DR",
                "D1NR",
                "D1RE"
            ],
            "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
            "example":"D1DR"
        },
        "message":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Information",
            "example":"Invalid input."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Information from the customer.

  Example: Device details not found.
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category within Oracle Utilities Application Framework.

  Example: 99999
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.

  Example: 99999
• messageParameters: array messageParameters
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  A unique Sequence number is given to each entry after the information is saved.

  Example: 1

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"A unique Sequence number is given to each entry after the information is saved.",
            "example":"1"
        },
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Category within Oracle Utilities Application Framework.",
            "example":"99999"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework.",
            "example":"99999"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Information from the customer.",
            "example":"Device details not found."
        },
        "messageParameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parameterSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"A unique Sequence number is given to each entry after the information is saved.",
                        "example":"1"
                    },
                    "messageParameterValue":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Message Parameter",
                        "example":"Any string"
                    }
                }
            }
        }
    }
}

Nested Schema : messageParameters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parameterSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"A unique Sequence number is given to each entry after the information is saved.",
                "example":"1"
            },
            "messageParameterValue":{
                "type":"string",
                "maxLength":2000,
                "description":"Message Parameter",
                "example":"Any string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• messageParameterValue: string
  Maximum Length: 2000

  Message Parameter

  Example: Any string
• parameterSequence: number
  Minimum Value: -999

  Maximum Value: 999

  A unique Sequence number is given to each entry after the information is saved.

  Example: 1

{
    "type":"object",
    "properties":{
        "parameterSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"A unique Sequence number is given to each entry after the information is saved.",
            "example":"1"
        },
        "messageParameterValue":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter",
            "example":"Any string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1DAPostAck

Type: object

Show Source

• deviceHeadendStatus: object deviceHeadendStatus
• exceptionInfo: array exceptionInfo
• hasError: boolean
  Indicates whether incoming message has any error.

  Example: true
• syncRequestId: string
  Maximum Length: 14

  The system-generated unique identifier for the outbound sync request.

  Example: 15449036987849

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "maxLength":14,
            "description":"The system-generated unique identifier for the outbound sync request.",
            "example":"15449036987849"
        },
        "exceptionInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"A unique Sequence number is given to each entry after the information is saved.",
                        "example":"1"
                    },
                    "messageCategory":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Message Category within Oracle Utilities Application Framework.",
                        "example":"99999"
                    },
                    "messageNumber":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Message Number within Oracle Utilities Application Framework.",
                        "example":"99999"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Information from the customer.",
                        "example":"Device details not found."
                    },
                    "messageParameters":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "parameterSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"A unique Sequence number is given to each entry after the information is saved.",
                                    "example":"1"
                                },
                                "messageParameterValue":{
                                    "type":"string",
                                    "maxLength":2000,
                                    "description":"Message Parameter",
                                    "example":"Any string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "deviceHeadendStatus":{
            "type":"object",
            "properties":{
                "deviceHeadendStatusList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "deviceId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Device ID"
                            },
                            "headEndRegistration":{
                                "type":"string",
                                "enum":[
                                    "D1DR",
                                    "D1NR",
                                    "D1RE"
                                ],
                                "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
                                "example":"D1DR"
                            },
                            "message":{
                                "type":"string",
                                "maxLength":2000,
                                "description":"Message Information",
                                "example":"Invalid input."
                            }
                        }
                    }
                }
            }
        },
        "hasError":{
            "type":"boolean",
            "description":"Indicates whether incoming message has any error.",
            "example":"true"
        }
    },
    "xml":{
        "name":"X1DAPostAck"
    }
}

Nested Schema : deviceHeadendStatus

Type: object

Show Source

• deviceHeadendStatusList: array deviceHeadendStatusList

{
    "type":"object",
    "properties":{
        "deviceHeadendStatusList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "deviceId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Device ID"
                    },
                    "headEndRegistration":{
                        "type":"string",
                        "enum":[
                            "D1DR",
                            "D1NR",
                            "D1RE"
                        ],
                        "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
                        "example":"D1DR"
                    },
                    "message":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Message Information",
                        "example":"Invalid input."
                    }
                }
            }
        }
    }
}

Nested Schema : exceptionInfo

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"A unique Sequence number is given to each entry after the information is saved.",
                "example":"1"
            },
            "messageCategory":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Message Category within Oracle Utilities Application Framework.",
                "example":"99999"
            },
            "messageNumber":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Message Number within Oracle Utilities Application Framework.",
                "example":"99999"
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Information from the customer.",
                "example":"Device details not found."
            },
            "messageParameters":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "parameterSequence":{
                            "type":"number",
                            "maximum":999,
                            "minimum":-999,
                            "description":"A unique Sequence number is given to each entry after the information is saved.",
                            "example":"1"
                        },
                        "messageParameterValue":{
                            "type":"string",
                            "maxLength":2000,
                            "description":"Message Parameter",
                            "example":"Any string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : deviceHeadendStatusList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "deviceId":{
                "type":"string",
                "maxLength":12,
                "description":"Device ID"
            },
            "headEndRegistration":{
                "type":"string",
                "enum":[
                    "D1DR",
                    "D1NR",
                    "D1RE"
                ],
                "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
                "example":"D1DR"
            },
            "message":{
                "type":"string",
                "maxLength":2000,
                "description":"Message Information",
                "example":"Invalid input."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• deviceId: string
  Maximum Length: 12

  Device ID
• headEndRegistration: string
  Allowed Values: [ "D1DR", "D1NR", "D1RE" ]

  Head End Registration Status of the Device. * `D1DR` - Deregistered, * `D1NR` - Not Registered, * `D1RE` - Registered

  Example: D1DR
• message: string
  Maximum Length: 2000

  Message Information

  Example: Invalid input.

{
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID"
        },
        "headEndRegistration":{
            "type":"string",
            "enum":[
                "D1DR",
                "D1NR",
                "D1RE"
            ],
            "description":"Head End Registration Status of the Device.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
            "example":"D1DR"
        },
        "message":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Information",
            "example":"Invalid input."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Information from the customer.

  Example: Device details not found.
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category within Oracle Utilities Application Framework.

  Example: 99999
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.

  Example: 99999
• messageParameters: array messageParameters
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  A unique Sequence number is given to each entry after the information is saved.

  Example: 1

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"A unique Sequence number is given to each entry after the information is saved.",
            "example":"1"
        },
        "messageCategory":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Category within Oracle Utilities Application Framework.",
            "example":"99999"
        },
        "messageNumber":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework.",
            "example":"99999"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Information from the customer.",
            "example":"Device details not found."
        },
        "messageParameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parameterSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"A unique Sequence number is given to each entry after the information is saved.",
                        "example":"1"
                    },
                    "messageParameterValue":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Message Parameter",
                        "example":"Any string"
                    }
                }
            }
        }
    }
}

Nested Schema : messageParameters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parameterSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"A unique Sequence number is given to each entry after the information is saved.",
                "example":"1"
            },
            "messageParameterValue":{
                "type":"string",
                "maxLength":2000,
                "description":"Message Parameter",
                "example":"Any string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• messageParameterValue: string
  Maximum Length: 2000

  Message Parameter

  Example: Any string
• parameterSequence: number
  Minimum Value: -999

  Maximum Value: 999

  A unique Sequence number is given to each entry after the information is saved.

  Example: 1

{
    "type":"object",
    "properties":{
        "parameterSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"A unique Sequence number is given to each entry after the information is saved.",
            "example":"1"
        },
        "messageParameterValue":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter",
            "example":"Any string"
        }
    }
}

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