| 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 | 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 .xml suffix or ?format=xml
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: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SuperAdminCreateSupportCase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CaseAreaId>0</CaseAreaId>
<CaseTypeId>0</CaseTypeId>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Description>String</Description>
<Title>String</Title>
</SuperAdminCreateSupportCase>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SupportCaseQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Attachments>
<SupportCaseAttachmentResponse>
<FileUrl>String</FileUrl>
<Id>0</Id>
</SupportCaseAttachmentResponse>
</Attachments>
<CaseArea>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</CaseArea>
<CaseAreaId>0</CaseAreaId>
<CaseAreaOptions>
<SupportCaseAreaResponse>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</SupportCaseAreaResponse>
</CaseAreaOptions>
<CaseOwner>String</CaseOwner>
<CaseStatus>
<Color>String</Color>
<Description>String</Description>
<Icon>String</Icon>
<Id>0</Id>
<Name>String</Name>
</CaseStatus>
<CaseStatusId>0</CaseStatusId>
<CaseStatusOptions>
<SupportCaseStatusResponse>
<Color>String</Color>
<Description>String</Description>
<Icon>String</Icon>
<Id>0</Id>
<Name>String</Name>
</SupportCaseStatusResponse>
</CaseStatusOptions>
<CaseType>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</CaseType>
<CaseTypeId>0</CaseTypeId>
<CaseTypeOptions>
<SupportCaseTypeResponse>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</SupportCaseTypeResponse>
</CaseTypeOptions>
<Comments>
<SupportCaseCommentsResponse>
<Comment>String</Comment>
<Created>0001-01-01T00:00:00</Created>
<CreatedBy>String</CreatedBy>
<Id>0</Id>
<SupportCaseId>0</SupportCaseId>
</SupportCaseCommentsResponse>
</Comments>
<CompanyUserId>00000000-0000-0000-0000-000000000000</CompanyUserId>
<Created>0001-01-01T00:00:00</Created>
<CreatedBy>String</CreatedBy>
<Description>String</Description>
<Id>0</Id>
<SolvedBy>String</SolvedBy>
<Title>String</Title>
<Updated>0001-01-01T00:00:00</Updated>
<UpdatedBy>String</UpdatedBy>
</SupportCaseQueryResponse>