Jump to

• Request
• Response

Calculate fees by intake form

post

/fscmRestApi/resources/11.13.18.05/publicSectorFeeRecords

Calculates fees based on values entered by the user on an intake form. It is display-only. The final fee charges are calculated after form submission.

Request

Supported Media Types

• application/vnd.oracle.adf.action+json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorFeeRecords-calculateFeesRequest

Type: object

Show Source

• name: string
  Allowed Values: [ "calculateFees" ]

  This parameter value must be set to "calculateFees".
• parameters(optional): array parameters
  Minimum Number of Items: 2

  Maximum Number of Items: 2

{
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "calculateFees"
            ],
            "description":"This parameter value must be set to \"calculateFees\"."
        },
        "parameters":{
            "items":[
                {
                    "properties":{
                        "recordTypeCode":{
                            "type":"string",
                            "description":"A unique alphanumeric code (short name) for the record type."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "metaData":{
                            "type":"string",
                            "description":"The values on the user intake form that are used to calculate fees."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                }
            ],
            "minItems":2,
            "maxItems":2,
            "type":"array"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Nested Schema : parameters

Type: array

Minimum Number of Items: 2

Maximum Number of Items: 2

Show Source

• [0]: object parameters-items[0]
• [1]: object parameters-items[1]

{
    "items":[
        {
            "properties":{
                "recordTypeCode":{
                    "type":"string",
                    "description":"A unique alphanumeric code (short name) for the record type."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "metaData":{
                    "type":"string",
                    "description":"The values on the user intake form that are used to calculate fees."
                }
            },
            "additionalProperties":false,
            "type":"object"
        }
    ],
    "minItems":2,
    "maxItems":2,
    "type":"array"
}

Nested Schema : parameters-items[0]

Type: object

Show Source

• recordTypeCode(optional): string
  A unique alphanumeric code (short name) for the record type.

{
    "properties":{
        "recordTypeCode":{
            "type":"string",
            "description":"A unique alphanumeric code (short name) for the record type."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[1]

Type: object

Show Source

• metaData(optional): string
  The values on the user intake form that are used to calculate fees.

{
    "properties":{
        "metaData":{
            "type":"string",
            "description":"The values on the user intake form that are used to calculate fees."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.actionresult+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorFeeRecords-calculateFeesResponse

Type: object

Show Source

• return(optional): string
  The response that contains the calculated fees, including the fee item ID, status, description, and fee amount.

{
    "properties":{
        "return":{
            "type":"string",
            "description":"The response that contains the calculated fees, including the fee item ID, status, description, and fee amount."
        }
    },
    "type":"object"
}

Back to Top