Jump to

• Request
• Response

Entity References Summary

post

https://server:port/spl/rest/apis/customer/v-model/entityReferences/hierarchyInfo

This service provides summary information for a selected list of entities along with their hierarchical information for presentation purposes.

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

• personId: string
  Maximum Length: 10

  Sets an optional scope for the referenced entities as associated with a specific person record.
• referenceEntities: array referenceEntities

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Sets an optional scope for the referenced entities as associated with a specific person record."
        },
        "referenceEntities":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "entityName":{
                        "type":"string",
                        "enum":[
                            "ACC ",
                            "BILL",
                            "DEV ",
                            "PREM",
                            "PYMT",
                            "SP  "
                        ],
                        "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
                    },
                    "entityId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Entity ID 1"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1EntRefSumm"
    }
}

Nested Schema : referenceEntities

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "entityName":{
                "type":"string",
                "enum":[
                    "ACC ",
                    "BILL",
                    "DEV ",
                    "PREM",
                    "PYMT",
                    "SP  "
                ],
                "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
            },
            "entityId":{
                "type":"string",
                "maxLength":60,
                "description":"Entity ID 1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• entityId: string
  Maximum Length: 60

  Entity ID 1
• entityName: string
  Allowed Values: [ "ACC ", "BILL", "DEV ", "PREM", "PYMT", "SP " ]

  Entity Hierarchy: * `ACC ` - Account, * `BILL` - Bill, * `DEV ` - Device, * `PREM` - Premise, * `PYMT` - Payment, * `SP ` - Service Point

{
    "type":"object",
    "properties":{
        "entityName":{
            "type":"string",
            "enum":[
                "ACC ",
                "BILL",
                "DEV ",
                "PREM",
                "PYMT",
                "SP  "
            ],
            "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
        },
        "entityId":{
            "type":"string",
            "maxLength":60,
            "description":"Entity ID 1"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• personId: string
  Maximum Length: 10

  Sets an optional scope for the referenced entities as associated with a specific person record.
• referenceEntities: array referenceEntities

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Sets an optional scope for the referenced entities as associated with a specific person record."
        },
        "referenceEntities":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "entityName":{
                        "type":"string",
                        "enum":[
                            "ACC ",
                            "BILL",
                            "DEV ",
                            "PREM",
                            "PYMT",
                            "SP  "
                        ],
                        "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
                    },
                    "entityId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Entity ID 1"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1EntRefSumm"
    }
}

Nested Schema : referenceEntities

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "entityName":{
                "type":"string",
                "enum":[
                    "ACC ",
                    "BILL",
                    "DEV ",
                    "PREM",
                    "PYMT",
                    "SP  "
                ],
                "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
            },
            "entityId":{
                "type":"string",
                "maxLength":60,
                "description":"Entity ID 1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• entityId: string
  Maximum Length: 60

  Entity ID 1
• entityName: string
  Allowed Values: [ "ACC ", "BILL", "DEV ", "PREM", "PYMT", "SP " ]

  Entity Hierarchy: * `ACC ` - Account, * `BILL` - Bill, * `DEV ` - Device, * `PREM` - Premise, * `PYMT` - Payment, * `SP ` - Service Point

{
    "type":"object",
    "properties":{
        "entityName":{
            "type":"string",
            "enum":[
                "ACC ",
                "BILL",
                "DEV ",
                "PREM",
                "PYMT",
                "SP  "
            ],
            "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
        },
        "entityId":{
            "type":"string",
            "maxLength":60,
            "description":"Entity ID 1"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1EntRefSumm

Type: object

Show Source

• entities: array entities

{
    "type":"object",
    "properties":{
        "entities":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "hierarchyLevel":{
                        "type":"number",
                        "maximum":9.99999999999999E8,
                        "minimum":0,
                        "description":"Represents the entity's relative hierarchical position in relationship to other referenced entities. \n\nThis information, along with each entity's reference to its immediate parent entity, may be used to present the entities in a hierarchical view. The lowest value represents the root level of the hierarchy."
                    },
                    "parentEntityName":{
                        "type":"string",
                        "enum":[
                            "ACC ",
                            "BILL",
                            "DEV ",
                            "PREM",
                            "PYMT",
                            "SP  "
                        ],
                        "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
                    },
                    "parentEntityId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Entity ID 1"
                    },
                    "entityName":{
                        "type":"string",
                        "enum":[
                            "ACC ",
                            "BILL",
                            "DEV ",
                            "PREM",
                            "PYMT",
                            "SP  "
                        ],
                        "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
                    },
                    "entityId":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Entity ID 1"
                    },
                    "referenceName":{
                        "type":"string",
                        "maxLength":60,
                        "description":"An optional alternate name for the referenced entity. For an account, this is the Account Name characteristic."
                    },
                    "description":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "primary":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Info"
                    },
                    "secondary":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Info"
                    },
                    "tertiary":{
                        "type":"string",
                        "maxLength":1000,
                        "description":"Info"
                    },
                    "restricted":{
                        "type":"boolean",
                        "description":"Indicates whether the user's access to the associated account is restricted or not. Minimal information is provided for restricted accounts."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1EntRefSumm"
    }
}

Nested Schema : entities

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "hierarchyLevel":{
                "type":"number",
                "maximum":9.99999999999999E8,
                "minimum":0,
                "description":"Represents the entity's relative hierarchical position in relationship to other referenced entities. \n\nThis information, along with each entity's reference to its immediate parent entity, may be used to present the entities in a hierarchical view. The lowest value represents the root level of the hierarchy."
            },
            "parentEntityName":{
                "type":"string",
                "enum":[
                    "ACC ",
                    "BILL",
                    "DEV ",
                    "PREM",
                    "PYMT",
                    "SP  "
                ],
                "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
            },
            "parentEntityId":{
                "type":"string",
                "maxLength":60,
                "description":"Entity ID 1"
            },
            "entityName":{
                "type":"string",
                "enum":[
                    "ACC ",
                    "BILL",
                    "DEV ",
                    "PREM",
                    "PYMT",
                    "SP  "
                ],
                "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
            },
            "entityId":{
                "type":"string",
                "maxLength":60,
                "description":"Entity ID 1"
            },
            "referenceName":{
                "type":"string",
                "maxLength":60,
                "description":"An optional alternate name for the referenced entity. For an account, this is the Account Name characteristic."
            },
            "description":{
                "type":"string",
                "maxLength":60,
                "description":"Description"
            },
            "primary":{
                "type":"string",
                "maxLength":1000,
                "description":"Info"
            },
            "secondary":{
                "type":"string",
                "maxLength":1000,
                "description":"Info"
            },
            "tertiary":{
                "type":"string",
                "maxLength":1000,
                "description":"Info"
            },
            "restricted":{
                "type":"boolean",
                "description":"Indicates whether the user's access to the associated account is restricted or not. Minimal information is provided for restricted accounts."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• description: string
  Maximum Length: 60

  Description
• entityId: string
  Maximum Length: 60

  Entity ID 1
• entityName: string
  Allowed Values: [ "ACC ", "BILL", "DEV ", "PREM", "PYMT", "SP " ]

  Entity Hierarchy: * `ACC ` - Account, * `BILL` - Bill, * `DEV ` - Device, * `PREM` - Premise, * `PYMT` - Payment, * `SP ` - Service Point
• hierarchyLevel: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Represents the entity's relative hierarchical position in relationship to other referenced entities. This information, along with each entity's reference to its immediate parent entity, may be used to present the entities in a hierarchical view. The lowest value represents the root level of the hierarchy.
• parentEntityId: string
  Maximum Length: 60

  Entity ID 1
• parentEntityName: string
  Allowed Values: [ "ACC ", "BILL", "DEV ", "PREM", "PYMT", "SP " ]

  Entity Hierarchy: * `ACC ` - Account, * `BILL` - Bill, * `DEV ` - Device, * `PREM` - Premise, * `PYMT` - Payment, * `SP ` - Service Point
• primary: string
  Maximum Length: 1000

  Info
• referenceName: string
  Maximum Length: 60

  An optional alternate name for the referenced entity. For an account, this is the Account Name characteristic.
• restricted: boolean
  Indicates whether the user's access to the associated account is restricted or not. Minimal information is provided for restricted accounts.
• secondary: string
  Maximum Length: 1000

  Info
• tertiary: string
  Maximum Length: 1000

  Info

{
    "type":"object",
    "properties":{
        "hierarchyLevel":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Represents the entity's relative hierarchical position in relationship to other referenced entities. \n\nThis information, along with each entity's reference to its immediate parent entity, may be used to present the entities in a hierarchical view. The lowest value represents the root level of the hierarchy."
        },
        "parentEntityName":{
            "type":"string",
            "enum":[
                "ACC ",
                "BILL",
                "DEV ",
                "PREM",
                "PYMT",
                "SP  "
            ],
            "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
        },
        "parentEntityId":{
            "type":"string",
            "maxLength":60,
            "description":"Entity ID 1"
        },
        "entityName":{
            "type":"string",
            "enum":[
                "ACC ",
                "BILL",
                "DEV ",
                "PREM",
                "PYMT",
                "SP  "
            ],
            "description":"Entity Hierarchy:\n* `ACC ` - Account,\n* `BILL` - Bill,\n* `DEV ` - Device,\n* `PREM` - Premise,\n* `PYMT` - Payment,\n* `SP  ` - Service Point"
        },
        "entityId":{
            "type":"string",
            "maxLength":60,
            "description":"Entity ID 1"
        },
        "referenceName":{
            "type":"string",
            "maxLength":60,
            "description":"An optional alternate name for the referenced entity. For an account, this is the Account Name characteristic."
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "primary":{
            "type":"string",
            "maxLength":1000,
            "description":"Info"
        },
        "secondary":{
            "type":"string",
            "maxLength":1000,
            "description":"Info"
        },
        "tertiary":{
            "type":"string",
            "maxLength":1000,
            "description":"Info"
        },
        "restricted":{
            "type":"boolean",
            "description":"Indicates whether the user's access to the associated account is restricted or not. Minimal information is provided for restricted accounts."
        }
    }
}

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