Jump to

• Request
• Response

Create fee assessments

post

/fscmRestApi/resources/11.13.18.05/hedFeeAssessments

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• InputData: string
  Input data in JSON format to assess fees for a transaction.
• PartyId: integer
  Unique identifier of a party, for example, a student.
• SourceObjectCode: string
  Code of the source transaction for which a fee must be assessed. Examples of source transactions can be a curriculum, or an application or transcript request.
• SourceObjectId: string
  Unique identifier of the source transaction for which a fee must be assessed. Examples of source transactions can be a curriculum, or an application or transcript request.

{
    "type":"object",
    "properties":{
        "SourceObjectId":{
            "type":"string",
            "description":"Unique identifier of the source transaction for which a fee must be assessed. Examples of source transactions can be a curriculum, or an application or transcript request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"Unique identifier of a party, for example, a student.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InputData":{
            "type":"string",
            "description":"Input data in JSON format to assess fees for a transaction.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SourceObjectCode":{
            "type":"string",
            "description":"Code of the source transaction for which a fee must be assessed. Examples of source transactions can be a curriculum, or an application or transcript request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : hedFeeAssessments-item-response

Type: object

Show Source

• InputData: string
  Input data in JSON format to assess fees for a transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OutputData: string
  Read Only: true

  Output data in JSON format for the assessed transaction.
• PartyId: integer
  Unique identifier of a party, for example, a student.
• SourceObjectCode: string
  Code of the source transaction for which a fee must be assessed. Examples of source transactions can be a curriculum, or an application or transcript request.
• SourceObjectId: string
  Unique identifier of the source transaction for which a fee must be assessed. Examples of source transactions can be a curriculum, or an application or transcript request.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceObjectId":{
            "type":"string",
            "description":"Unique identifier of the source transaction for which a fee must be assessed. Examples of source transactions can be a curriculum, or an application or transcript request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"Unique identifier of a party, for example, a student.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InputData":{
            "type":"string",
            "description":"Input data in JSON format to assess fees for a transaction.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SourceObjectCode":{
            "type":"string",
            "description":"Code of the source transaction for which a fee must be assessed. Examples of source transactions can be a curriculum, or an application or transcript request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OutputData":{
            "type":"string",
            "description":"Output data in JSON format for the assessed transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top