Jump to

• Request
• Response

Evaluate Bill Simulation Eligibility

post

/bills/simulation/evaluate

Evaluates subscriber eligibility for bill simulation. The optional end time is an ISO-8601 date.

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

• accountRef(required): object ResourceRef
• billRef(required): object ResourceRef
• endTime: string (date-time)
  End date for the eligibility evaluation. If omitted, BRM uses the current time.

{
    "required":[
        "accountRef",
        "billRef"
    ],
    "type":"object",
    "properties":{
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "endTime":{
            "type":"string",
            "description":"End date for the eligibility evaluation. If omitted, BRM uses the current time.",
            "format":"date-time"
        }
    },
    "xml":{
        "name":"billSimulationEvaluation",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountRef(required): object ResourceRef
• billRef(required): object ResourceRef
• endTime: string (date-time)
  End date for the eligibility evaluation. If omitted, BRM uses the current time.

{
    "required":[
        "accountRef",
        "billRef"
    ],
    "type":"object",
    "properties":{
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "endTime":{
            "type":"string",
            "description":"End date for the eligibility evaluation. If omitted, BRM uses the current time.",
            "format":"date-time"
        }
    },
    "xml":{
        "name":"billSimulationEvaluation",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The simulation eligibility was evaluated.

Body ()

Root Schema : billSimulationEvaluationResult

Type: object

Show Source

• accountRef(required): object ResourceRef
• billRef(required): object ResourceRef
• deals: array deals
• discounts: array discounts
• products: array products
• reasonCode(required): string
• result: integer (int32)
• services: array services

{
    "required":[
        "accountRef",
        "billRef",
        "reasonCode"
    ],
    "type":"object",
    "properties":{
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "result":{
            "type":"integer",
            "format":"int32"
        },
        "reasonCode":{
            "type":"string"
        },
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRef"
            }
        },
        "deals":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRef"
            }
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRef"
            }
        },
        "discounts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRef"
            }
        }
    },
    "xml":{
        "name":"billSimulationEvaluationResult",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : deals

Type: array

Show Source

• Array of: object ResourceRef

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRef"
    }
}

Nested Schema : discounts

Type: array

Show Source

• Array of: object ResourceRef

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRef"
    }
}

Nested Schema : products

Type: array

Show Source

• Array of: object ResourceRef

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRef"
    }
}

Nested Schema : services

Type: array

Show Source

• Array of: object ResourceRef

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRef"
    }
}

400 Response

The request isn't valid.

403 Response

Access isn't granted.

500 Response

An internal server error occurred.

Back to Top