Jump to

• Request
• Response

Create a case appeal

post

/fscmRestApi/resources/11.13.18.05/publicSectorCaseAppeals

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorCaseAppeals-item

Type: object

Show Source

• AppealReason(optional): string
  Title: Appeal Reason

  Maximum Length: 1000

  The reason for the case appeal.
• AppealSrc(optional): string
  Maximum Length: 10

  The source of the transaction such as Appeal or Hearing.
• AppealStatus(optional): string
  Title: Status

  Maximum Length: 15

  The status of the case appeal.
• CaseAppealKey(optional): integer(int64)
  The unique identifier of the case appeal.
• CaseAppealPuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case appeal record.
• CaseComplianceDueDate(optional): string(date)
  Title: New Compliance Due Date

  The case compliance due date.
• CaseContactKey(optional): integer(int64)
  The unique identifier of the case contact.
• CaseContactPuid(optional): string
  The public unique identifier of the migrated case contact record.
• CaseFunctionalStatus(optional): string
  The user defined case status name that maps to a delivered system status.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• CaseStatus(optional): string
  Title: Appeal Type

  Maximum Length: 15

  The status of the case.
• CitationDueDate(optional): string(date)
  Title: New Citation Due Date

  The citation due date.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments for the case appeal.
• ComplianceDueDate(optional): string(date)
  The compliance date of the case.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• DecisionDate(optional): string(date-time)
  Title: Decision Date

  The hearing decision date for the case appeal.
• EventDecision(optional): string
  Maximum Length: 15

  The system defined status of the hearing decision.
• GenCitFlag(optional): string
  Maximum Length: 1

  Identifies if a citation should be issued.
• GenVioFlag(optional): string
  Maximum Length: 1

  Identifies if a notice of violation should be issued.
• HearingDate(optional): string(date-time)
  Title: Hearing Date

  The hearing date for the case appeal.
• HearingDecision(optional): string
  Title: Hearing Decision

  Maximum Length: 15

  The hearing decision from the case appeal.
• HrgBodyCode(optional): string
  Maximum Length: 60

  The identifier of the hearing body configured in the system.
• HrgDecisionCode(optional): string
  Maximum Length: 15

  The user defined status of the hearing decision.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• PersonFirstName(optional): string
  Title: First Name

  Maximum Length: 150

  The first name of the appellant.
• PersonLastName(optional): string
  Title: Last Name

  Maximum Length: 150

  The last name of the appellant.
• RespContactKey(optional): integer(int64)
  The identifier of the person responsible for the appeal or hearing that is being processed.

{
    "properties":{
        "AppealReason":{
            "maxLength":1000,
            "type":"string",
            "description":"The reason for the case appeal.",
            "title":"Appeal Reason"
        },
        "AppealSrc":{
            "maxLength":10,
            "type":"string",
            "description":"The source of the transaction such as Appeal or Hearing."
        },
        "AppealStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case appeal.",
            "title":"Status"
        },
        "CaseAppealKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case appeal."
        },
        "CaseAppealPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case appeal record."
        },
        "CaseComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The case compliance due date.",
            "title":"New Compliance Due Date"
        },
        "CaseContactKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case contact."
        },
        "CaseContactPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated case contact record."
        },
        "CaseFunctionalStatus":{
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status."
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record."
        },
        "CaseStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case.",
            "title":"Appeal Type"
        },
        "CitationDueDate":{
            "format":"date",
            "type":"string",
            "description":"The citation due date.",
            "title":"New Citation Due Date"
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments for the case appeal.",
            "title":"Comments"
        },
        "ComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The compliance date of the case."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "DecisionDate":{
            "format":"date-time",
            "type":"string",
            "description":"The hearing decision date for the case appeal.",
            "title":"Decision Date"
        },
        "EventDecision":{
            "maxLength":15,
            "type":"string",
            "description":"The system defined status of the hearing decision."
        },
        "GenCitFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies if a citation should be issued."
        },
        "GenVioFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies if a notice of violation should be issued."
        },
        "HearingDate":{
            "format":"date-time",
            "type":"string",
            "description":"The hearing date for the case appeal.",
            "title":"Hearing Date"
        },
        "HearingDecision":{
            "maxLength":15,
            "type":"string",
            "description":"The hearing decision from the case appeal.",
            "title":"Hearing Decision"
        },
        "HrgBodyCode":{
            "maxLength":60,
            "type":"string",
            "description":"The identifier of the hearing body configured in the system."
        },
        "HrgDecisionCode":{
            "maxLength":15,
            "type":"string",
            "description":"The user defined status of the hearing decision."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the appellant.",
            "title":"First Name"
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the appellant.",
            "title":"Last Name"
        },
        "RespContactKey":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the person responsible for the appeal or hearing that is being processed."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCaseAppeals-item

Type: object

Show Source

• AppealReason(optional): string
  Title: Appeal Reason

  Maximum Length: 1000

  The reason for the case appeal.
• AppealSrc(optional): string
  Maximum Length: 10

  The source of the transaction such as Appeal or Hearing.
• AppealStatus(optional): string
  Title: Status

  Maximum Length: 15

  The status of the case appeal.
• CaseAppealKey(optional): integer(int64)
  The unique identifier of the case appeal.
• CaseAppealPuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case appeal record.
• CaseComplianceDueDate(optional): string(date)
  Title: New Compliance Due Date

  The case compliance due date.
• CaseContactKey(optional): integer(int64)
  The unique identifier of the case contact.
• CaseContactPuid(optional): string
  The public unique identifier of the migrated case contact record.
• CaseFunctionalStatus(optional): string
  The user defined case status name that maps to a delivered system status.
• CaseKey(optional): integer(int64)
  The unique identifier of the case.
• CasePuid(optional): string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• CaseStatus(optional): string
  Title: Appeal Type

  Maximum Length: 15

  The status of the case.
• CitationDueDate(optional): string(date)
  Title: New Citation Due Date

  The citation due date.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments for the case appeal.
• ComplianceDueDate(optional): string(date)
  The compliance date of the case.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• DecisionDate(optional): string(date-time)
  Title: Decision Date

  The hearing decision date for the case appeal.
• EventDecision(optional): string
  Maximum Length: 15

  The system defined status of the hearing decision.
• GenCitFlag(optional): string
  Maximum Length: 1

  Identifies if a citation should be issued.
• GenVioFlag(optional): string
  Maximum Length: 1

  Identifies if a notice of violation should be issued.
• HearingDate(optional): string(date-time)
  Title: Hearing Date

  The hearing date for the case appeal.
• HearingDecision(optional): string
  Title: Hearing Decision

  Maximum Length: 15

  The hearing decision from the case appeal.
• HrgBodyCode(optional): string
  Maximum Length: 60

  The identifier of the hearing body configured in the system.
• HrgDecisionCode(optional): string
  Maximum Length: 15

  The user defined status of the hearing decision.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• PersonFirstName(optional): string
  Title: First Name

  Maximum Length: 150

  The first name of the appellant.
• PersonLastName(optional): string
  Title: Last Name

  Maximum Length: 150

  The last name of the appellant.
• RespContactKey(optional): integer(int64)
  The identifier of the person responsible for the appeal or hearing that is being processed.

{
    "properties":{
        "AppealReason":{
            "maxLength":1000,
            "type":"string",
            "description":"The reason for the case appeal.",
            "title":"Appeal Reason"
        },
        "AppealSrc":{
            "maxLength":10,
            "type":"string",
            "description":"The source of the transaction such as Appeal or Hearing."
        },
        "AppealStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case appeal.",
            "title":"Status"
        },
        "CaseAppealKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case appeal."
        },
        "CaseAppealPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case appeal record."
        },
        "CaseComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The case compliance due date.",
            "title":"New Compliance Due Date"
        },
        "CaseContactKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case contact."
        },
        "CaseContactPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated case contact record."
        },
        "CaseFunctionalStatus":{
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status."
        },
        "CaseKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the case."
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record."
        },
        "CaseStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the case.",
            "title":"Appeal Type"
        },
        "CitationDueDate":{
            "format":"date",
            "type":"string",
            "description":"The citation due date.",
            "title":"New Citation Due Date"
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments for the case appeal.",
            "title":"Comments"
        },
        "ComplianceDueDate":{
            "format":"date",
            "type":"string",
            "description":"The compliance date of the case."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "DecisionDate":{
            "format":"date-time",
            "type":"string",
            "description":"The hearing decision date for the case appeal.",
            "title":"Decision Date"
        },
        "EventDecision":{
            "maxLength":15,
            "type":"string",
            "description":"The system defined status of the hearing decision."
        },
        "GenCitFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies if a citation should be issued."
        },
        "GenVioFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies if a notice of violation should be issued."
        },
        "HearingDate":{
            "format":"date-time",
            "type":"string",
            "description":"The hearing date for the case appeal.",
            "title":"Hearing Date"
        },
        "HearingDecision":{
            "maxLength":15,
            "type":"string",
            "description":"The hearing decision from the case appeal.",
            "title":"Hearing Decision"
        },
        "HrgBodyCode":{
            "maxLength":60,
            "type":"string",
            "description":"The identifier of the hearing body configured in the system."
        },
        "HrgDecisionCode":{
            "maxLength":15,
            "type":"string",
            "description":"The user defined status of the hearing decision."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the appellant.",
            "title":"First Name"
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the appellant.",
            "title":"Last Name"
        },
        "RespContactKey":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the person responsible for the appeal or hearing that is being processed."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top