Appeal

Update Appeal

HTTP Request

PUT /api/appeals/{id}

📋 Description: Updates the details of a specific appeal identified by its unique ID, allowing for modifications to the appeal’s status, reason, or associated documentation to ensure accurate record-keeping and compliance.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

AppealDto

true

Request body containing the updated appeal details, including status, justification, and relevant metadata for processing.

Body Parameters

  1{
  2  "createdBy": "string",
  3  "lastModifiedBy": "string",
  4  "createdDate": "2019-08-24T14:15:22Z",
  5  "lastModifiedDate": "2019-08-24T14:15:22Z",
  6  "archived": true,
  7  "externalId": "string",
  8  "id": 0,
  9  "appealAssessmentId": 0,
 10  "appealReviewedId": 0,
 11  "appealed": true,
 12  "appealActionId": 0,
 13  "followUpDate": "2019-08-24",
 14  "targetedAssessment": 0,
 15  "revisedAssessment": 0,
 16  "appealNegotiationId": 0,
 17  "settlementDate": "2019-08-24",
 18  "note": "string",
 19  "savings": [
 20    {
 21      "year": 0,
 22      "savings": 0
 23    }
 24  ],
 25  "assessmentId": 0,
 26  "assessmentExternalId": "string",
 27  "appealAssessment": {
 28    "createdBy": "string",
 29    "lastModifiedBy": "string",
 30    "createdDate": "2019-08-24T14:15:22Z",
 31    "lastModifiedDate": "2019-08-24T14:15:22Z",
 32    "archived": true,
 33    "externalId": "string",
 34    "id": 0,
 35    "priority": 0,
 36    "internalId": 0,
 37    "pickListCode": "string",
 38    "pickListLabel": "string",
 39    "label": "string",
 40    "cultureId": 0,
 41    "labelDtos": [
 42      {
 43        "createdBy": "string",
 44        "lastModifiedBy": "string",
 45        "createdDate": "2019-08-24T14:15:22Z",
 46        "lastModifiedDate": "2019-08-24T14:15:22Z",
 47        "archived": true,
 48        "externalId": "string",
 49        "id": 0,
 50        "cultureId": 0,
 51        "value": "string"
 52      }
 53    ]
 54  },
 55  "appealReviewed": {
 56    "createdBy": "string",
 57    "lastModifiedBy": "string",
 58    "createdDate": "2019-08-24T14:15:22Z",
 59    "lastModifiedDate": "2019-08-24T14:15:22Z",
 60    "archived": true,
 61    "externalId": "string",
 62    "id": 0,
 63    "priority": 0,
 64    "internalId": 0,
 65    "pickListCode": "string",
 66    "pickListLabel": "string",
 67    "label": "string",
 68    "cultureId": 0,
 69    "labelDtos": [
 70      {
 71        "createdBy": "string",
 72        "lastModifiedBy": "string",
 73        "createdDate": "2019-08-24T14:15:22Z",
 74        "lastModifiedDate": "2019-08-24T14:15:22Z",
 75        "archived": true,
 76        "externalId": "string",
 77        "id": 0,
 78        "cultureId": 0,
 79        "value": "string"
 80      }
 81    ]
 82  },
 83  "appealAction": {
 84    "createdBy": "string",
 85    "lastModifiedBy": "string",
 86    "createdDate": "2019-08-24T14:15:22Z",
 87    "lastModifiedDate": "2019-08-24T14:15:22Z",
 88    "archived": true,
 89    "externalId": "string",
 90    "id": 0,
 91    "priority": 0,
 92    "internalId": 0,
 93    "pickListCode": "string",
 94    "pickListLabel": "string",
 95    "label": "string",
 96    "cultureId": 0,
 97    "labelDtos": [
 98      {
 99        "createdBy": "string",
100        "lastModifiedBy": "string",
101        "createdDate": "2019-08-24T14:15:22Z",
102        "lastModifiedDate": "2019-08-24T14:15:22Z",
103        "archived": true,
104        "externalId": "string",
105        "id": 0,
106        "cultureId": 0,
107        "value": "string"
108      }
109    ]
110  },
111  "appealNegotiation": {
112    "createdBy": "string",
113    "lastModifiedBy": "string",
114    "createdDate": "2019-08-24T14:15:22Z",
115    "lastModifiedDate": "2019-08-24T14:15:22Z",
116    "archived": true,
117    "externalId": "string",
118    "id": 0,
119    "priority": 0,
120    "internalId": 0,
121    "pickListCode": "string",
122    "pickListLabel": "string",
123    "label": "string",
124    "cultureId": 0,
125    "labelDtos": [
126      {
127        "createdBy": "string",
128        "lastModifiedBy": "string",
129        "createdDate": "2019-08-24T14:15:22Z",
130        "lastModifiedDate": "2019-08-24T14:15:22Z",
131        "archived": true,
132        "externalId": "string",
133        "id": 0,
134        "cultureId": 0,
135        "value": "string"
136      }
137    ]
138  }
139}

Responses

Status

Meaning

Description

Schema

200

OK

OK

AppealDto

Example Responses

  1{
  2  "createdBy": "string",
  3  "lastModifiedBy": "string",
  4  "createdDate": "2019-08-24T14:15:22Z",
  5  "lastModifiedDate": "2019-08-24T14:15:22Z",
  6  "archived": true,
  7  "externalId": "string",
  8  "id": 0,
  9  "appealAssessmentId": 0,
 10  "appealReviewedId": 0,
 11  "appealed": true,
 12  "appealActionId": 0,
 13  "followUpDate": "2019-08-24",
 14  "targetedAssessment": 0,
 15  "revisedAssessment": 0,
 16  "appealNegotiationId": 0,
 17  "settlementDate": "2019-08-24",
 18  "note": "string",
 19  "savings": [
 20    {
 21      "year": 0,
 22      "savings": 0
 23    }
 24  ],
 25  "assessmentId": 0,
 26  "assessmentExternalId": "string",
 27  "appealAssessment": {
 28    "createdBy": "string",
 29    "lastModifiedBy": "string",
 30    "createdDate": "2019-08-24T14:15:22Z",
 31    "lastModifiedDate": "2019-08-24T14:15:22Z",
 32    "archived": true,
 33    "externalId": "string",
 34    "id": 0,
 35    "priority": 0,
 36    "internalId": 0,
 37    "pickListCode": "string",
 38    "pickListLabel": "string",
 39    "label": "string",
 40    "cultureId": 0,
 41    "labelDtos": [
 42      {
 43        "createdBy": "string",
 44        "lastModifiedBy": "string",
 45        "createdDate": "2019-08-24T14:15:22Z",
 46        "lastModifiedDate": "2019-08-24T14:15:22Z",
 47        "archived": true,
 48        "externalId": "string",
 49        "id": 0,
 50        "cultureId": 0,
 51        "value": "string"
 52      }
 53    ]
 54  },
 55  "appealReviewed": {
 56    "createdBy": "string",
 57    "lastModifiedBy": "string",
 58    "createdDate": "2019-08-24T14:15:22Z",
 59    "lastModifiedDate": "2019-08-24T14:15:22Z",
 60    "archived": true,
 61    "externalId": "string",
 62    "id": 0,
 63    "priority": 0,
 64    "internalId": 0,
 65    "pickListCode": "string",
 66    "pickListLabel": "string",
 67    "label": "string",
 68    "cultureId": 0,
 69    "labelDtos": [
 70      {
 71        "createdBy": "string",
 72        "lastModifiedBy": "string",
 73        "createdDate": "2019-08-24T14:15:22Z",
 74        "lastModifiedDate": "2019-08-24T14:15:22Z",
 75        "archived": true,
 76        "externalId": "string",
 77        "id": 0,
 78        "cultureId": 0,
 79        "value": "string"
 80      }
 81    ]
 82  },
 83  "appealAction": {
 84    "createdBy": "string",
 85    "lastModifiedBy": "string",
 86    "createdDate": "2019-08-24T14:15:22Z",
 87    "lastModifiedDate": "2019-08-24T14:15:22Z",
 88    "archived": true,
 89    "externalId": "string",
 90    "id": 0,
 91    "priority": 0,
 92    "internalId": 0,
 93    "pickListCode": "string",
 94    "pickListLabel": "string",
 95    "label": "string",
 96    "cultureId": 0,
 97    "labelDtos": [
 98      {
 99        "createdBy": "string",
100        "lastModifiedBy": "string",
101        "createdDate": "2019-08-24T14:15:22Z",
102        "lastModifiedDate": "2019-08-24T14:15:22Z",
103        "archived": true,
104        "externalId": "string",
105        "id": 0,
106        "cultureId": 0,
107        "value": "string"
108      }
109    ]
110  },
111  "appealNegotiation": {
112    "createdBy": "string",
113    "lastModifiedBy": "string",
114    "createdDate": "2019-08-24T14:15:22Z",
115    "lastModifiedDate": "2019-08-24T14:15:22Z",
116    "archived": true,
117    "externalId": "string",
118    "id": 0,
119    "priority": 0,
120    "internalId": 0,
121    "pickListCode": "string",
122    "pickListLabel": "string",
123    "label": "string",
124    "cultureId": 0,
125    "labelDtos": [
126      {
127        "createdBy": "string",
128        "lastModifiedBy": "string",
129        "createdDate": "2019-08-24T14:15:22Z",
130        "lastModifiedDate": "2019-08-24T14:15:22Z",
131        "archived": true,
132        "externalId": "string",
133        "id": 0,
134        "cultureId": 0,
135        "value": "string"
136      }
137    ]
138  }
139}

Delete Appeal

HTTP Request

DELETE /api/appeals/{id}

📋 Description: Deletes a specific appeal identified by its unique ID, ensuring the removal of outdated or unnecessary records from the system.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None