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
Root Schema : schema
Type:
Show Source
object-
deviceHeadendStatus: object
deviceHeadendStatus
-
exceptionInfo: array
exceptionInfo
-
hasError: boolean
Indicates whether incoming message has any error.Example:
true -
syncRequestId: string
Maximum Length:
14The system-generated unique identifier for the outbound sync request.Example:15449036987849
Nested Schema : items
Type:
Show Source
object-
deviceId: string
Maximum Length:
12Device ID -
headEndRegistration: string
Allowed Values:
[ "D1DR", "D1NR", "D1RE" ]Head End Registration Status of the Device. * `D1DR` - Deregistered, * `D1NR` - Not Registered, * `D1RE` - RegisteredExample:D1DR -
message: string
Maximum Length:
2000Message InformationExample:Invalid input.
Nested Schema : items
Type:
Show Source
object-
comments: string
Maximum Length:
254Information from the customer.Example:Device details not found. -
messageCategory: number
Minimum Value:
-99999Maximum Value:99999Message Category within Oracle Utilities Application Framework.Example:99999 -
messageNumber: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework.Example:99999 -
messageParameters: array
messageParameters
-
sequence: number
Minimum Value:
-999Maximum Value:999A unique Sequence number is given to each entry after the information is saved.Example:1
Nested Schema : items
Type:
Show Source
object-
messageParameterValue: string
Maximum Length:
2000Message ParameterExample:Any string -
parameterSequence: number
Minimum Value:
-999Maximum Value:999A unique Sequence number is given to each entry after the information is saved.Example:1
Root Schema : schema
Type:
Show Source
object-
deviceHeadendStatus: object
deviceHeadendStatus
-
exceptionInfo: array
exceptionInfo
-
hasError: boolean
Indicates whether incoming message has any error.Example:
true -
syncRequestId: string
Maximum Length:
14The system-generated unique identifier for the outbound sync request.Example:15449036987849
Nested Schema : items
Type:
Show Source
object-
deviceId: string
Maximum Length:
12Device ID -
headEndRegistration: string
Allowed Values:
[ "D1DR", "D1NR", "D1RE" ]Head End Registration Status of the Device. * `D1DR` - Deregistered, * `D1NR` - Not Registered, * `D1RE` - RegisteredExample:D1DR -
message: string
Maximum Length:
2000Message InformationExample:Invalid input.
Nested Schema : items
Type:
Show Source
object-
comments: string
Maximum Length:
254Information from the customer.Example:Device details not found. -
messageCategory: number
Minimum Value:
-99999Maximum Value:99999Message Category within Oracle Utilities Application Framework.Example:99999 -
messageNumber: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework.Example:99999 -
messageParameters: array
messageParameters
-
sequence: number
Minimum Value:
-999Maximum Value:999A unique Sequence number is given to each entry after the information is saved.Example:1
Nested Schema : items
Type:
Show Source
object-
messageParameterValue: string
Maximum Length:
2000Message ParameterExample:Any string -
parameterSequence: number
Minimum Value:
-999Maximum Value:999A unique Sequence number is given to each entry after the information is saved.Example:1
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1DAPostAck
Type:
Show Source
object-
deviceHeadendStatus: object
deviceHeadendStatus
-
exceptionInfo: array
exceptionInfo
-
hasError: boolean
Indicates whether incoming message has any error.Example:
true -
syncRequestId: string
Maximum Length:
14The system-generated unique identifier for the outbound sync request.Example:15449036987849
Nested Schema : items
Type:
Show Source
object-
deviceId: string
Maximum Length:
12Device ID -
headEndRegistration: string
Allowed Values:
[ "D1DR", "D1NR", "D1RE" ]Head End Registration Status of the Device. * `D1DR` - Deregistered, * `D1NR` - Not Registered, * `D1RE` - RegisteredExample:D1DR -
message: string
Maximum Length:
2000Message InformationExample:Invalid input.
Nested Schema : items
Type:
Show Source
object-
comments: string
Maximum Length:
254Information from the customer.Example:Device details not found. -
messageCategory: number
Minimum Value:
-99999Maximum Value:99999Message Category within Oracle Utilities Application Framework.Example:99999 -
messageNumber: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework.Example:99999 -
messageParameters: array
messageParameters
-
sequence: number
Minimum Value:
-999Maximum Value:999A unique Sequence number is given to each entry after the information is saved.Example:1
Nested Schema : items
Type:
Show Source
object-
messageParameterValue: string
Maximum Length:
2000Message ParameterExample:Any string -
parameterSequence: number
Minimum Value:
-999Maximum Value:999A unique Sequence number is given to each entry after the information is saved.Example:1
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.