Requires the role: | superadmin |
POST | /superadmin/support/cases | Add a new support case | Add a new 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. |
Title | body | string | No | The case title. |
Description | body | string | No | 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 | No | The case title. |
Description | form | string | No | 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 | No | The case created by. |
UpdatedBy | form | string | No | The case updated by. |
SolvedBy | form | string | No | The case solved by. |
Updated | form | DateTime | No | If case updated date. |
Created | form | DateTime | No | If case created date. |
CaseOwner | form | string | No | Who owns the support case. |
CaseStatus | form | SupportCaseStatusResponse | No | The case status information. |
CaseType | form | SupportCaseTypeResponse | No | The case type information. |
CaseArea | form | SupportCaseAreaResponse | No | The case area information. |
Comments | form | List<SupportCaseCommentsResponse> | No | The case comments. |
Attachments | form | List<SupportCaseAttachmentResponse> | No | The case attachments. |
CaseStatusOptions | form | List<SupportCaseStatusResponse> | No | The case status options to select from. |
CaseTypeOptions | form | List<SupportCaseTypeResponse> | No | The case type options to select from. |
CaseAreaOptions | form | List<SupportCaseAreaResponse> | No | The case area options to select from. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The status id |
Name | form | string | No | The status name |
Description | form | string | No | The status description |
Icon | form | string | No | The status icon |
Color | form | string | No | The status color |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The type id |
Name | form | string | No | The type name |
Description | form | string | No | The type description |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The area id |
Name | form | string | No | The area name |
Description | form | string | No | 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 | No | The case comment |
CreatedBy | form | string | No | 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 | No | The attachment file url |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /superadmin/support/cases HTTP/1.1
Host: api.bokamera.se
Accept: application/json
Content-Type: application/json
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Title":"String","Description":"String","CaseTypeId":0,"CaseAreaId":0}
HTTP/1.1 200 OK Content-Type: application/json 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"}]}