| Requires the role: | superadmin |
| PUT | /superadmin/support/cases/{Id} | Update a support case | Update a support case to the company of the currently logged in user, only administrators are allowed to add support cases. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | Yes | Enter the company id, if blank company id and you are an admin, your company id will be used. |
| Id | path | int | No | The support case id |
| Title | body | string | Yes | The case title. |
| Description | body | string | Yes | The case description. |
| CaseTypeId | body | int? | No | If the case type id. |
| CaseAreaId | body | int? | No | If the case area id. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The support case id |
| CompanyUserId | form | Guid | No | The company user id |
| Title | form | string | Yes | The case title. |
| Description | form | string | Yes | The case description. |
| CaseStatusId | form | int | No | The case status id. |
| CaseTypeId | form | int | No | If the case type id. |
| CaseAreaId | form | int | No | If the case area id. |
| CreatedBy | form | string | Yes | The case created by. |
| UpdatedBy | form | string | Yes | The case updated by. |
| SolvedBy | form | string | Yes | The case solved by. |
| Updated | form | DateTime | No | If case updated date. |
| Created | form | DateTime | No | If case created date. |
| CaseOwner | form | string | Yes | Who owns the support case. |
| CaseStatus | form | SupportCaseStatusResponse | Yes | The case status information. |
| CaseType | form | SupportCaseTypeResponse | Yes | The case type information. |
| CaseArea | form | SupportCaseAreaResponse | Yes | The case area information. |
| Comments | form | List<SupportCaseCommentsResponse> | Yes | The case comments. |
| Attachments | form | List<SupportCaseAttachmentResponse> | Yes | The case attachments. |
| CaseStatusOptions | form | List<SupportCaseStatusResponse> | Yes | The case status options to select from. |
| CaseTypeOptions | form | List<SupportCaseTypeResponse> | Yes | The case type options to select from. |
| CaseAreaOptions | form | List<SupportCaseAreaResponse> | Yes | The case area options to select from. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The status id |
| Name | form | string | Yes | The status name |
| Description | form | string | Yes | The status description |
| Icon | form | string | Yes | The status icon |
| Color | form | string | Yes | The status color |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The type id |
| Name | form | string | Yes | The type name |
| Description | form | string | Yes | The type description |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The area id |
| Name | form | string | Yes | The area name |
| Description | form | string | Yes | The area description |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SupportCaseId | form | int | No | The case id |
| Id | form | int | No | The comments id |
| Comment | form | string | Yes | The case comment |
| CreatedBy | form | string | Yes | The case comment created by |
| Created | form | DateTime | No | The case comment created date |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The attachment id |
| FileUrl | form | string | Yes | The attachment file url |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /superadmin/support/cases/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Id: 0,
Title: String,
Description: String,
CaseTypeId: 0,
CaseAreaId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Title: String,
Description: String,
CaseStatusId: 0,
CaseTypeId: 0,
CaseAreaId: 0,
CreatedBy: String,
UpdatedBy: String,
SolvedBy: String,
CaseOwner: String,
CaseStatus:
{
Id: 0,
Name: String,
Description: String,
Icon: String,
Color: String
},
CaseType:
{
Id: 0,
Name: String,
Description: String
},
CaseArea:
{
Id: 0,
Name: String,
Description: String
},
Comments:
[
{
SupportCaseId: 0,
Id: 0,
Comment: String,
CreatedBy: String
}
],
Attachments:
[
{
Id: 0,
FileUrl: String
}
],
CaseStatusOptions:
[
{
Id: 0,
Name: String,
Description: String,
Icon: String,
Color: String
}
],
CaseTypeOptions:
[
{
Id: 0,
Name: String,
Description: String
}
],
CaseAreaOptions:
[
{
Id: 0,
Name: String,
Description: String
}
]
}