BokaMera.API.Host

<back to all web services

SuperAdminCreateSupportCase

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
POST/superadmin/support/casesAdd a new support caseAdd a new support case to the company of the currently logged in user, only administrators are allowed to add support cases.
SuperAdminCreateSupportCase Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?YesEnter the company id, if blank company id and you are an admin, your company id will be used.
TitlebodystringYesThe case title.
DescriptionbodystringYesThe case description.
CaseTypeIdbodyintNoIf the case type id.
CaseAreaIdbodyintNoIf the case area id.
SupportCaseQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe support case id
CompanyUserIdformGuidNoThe company user id
TitleformstringYesThe case title.
DescriptionformstringYesThe case description.
CaseStatusIdformintNoThe case status id.
CaseTypeIdformintNoIf the case type id.
CaseAreaIdformintNoIf the case area id.
CreatedByformstringYesThe case created by.
UpdatedByformstringYesThe case updated by.
SolvedByformstringYesThe case solved by.
UpdatedformDateTimeNoIf case updated date.
CreatedformDateTimeNoIf case created date.
CaseOwnerformstringYesWho owns the support case.
CaseStatusformSupportCaseStatusResponseYesThe case status information.
CaseTypeformSupportCaseTypeResponseYesThe case type information.
CaseAreaformSupportCaseAreaResponseYesThe case area information.
CommentsformList<SupportCaseCommentsResponse>YesThe case comments.
AttachmentsformList<SupportCaseAttachmentResponse>YesThe case attachments.
CaseStatusOptionsformList<SupportCaseStatusResponse>YesThe case status options to select from.
CaseTypeOptionsformList<SupportCaseTypeResponse>YesThe case type options to select from.
CaseAreaOptionsformList<SupportCaseAreaResponse>YesThe case area options to select from.
SupportCaseStatusResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe status id
NameformstringYesThe status name
DescriptionformstringYesThe status description
IconformstringYesThe status icon
ColorformstringYesThe status color
SupportCaseTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe type id
NameformstringYesThe type name
DescriptionformstringYesThe type description
SupportCaseAreaResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe area id
NameformstringYesThe area name
DescriptionformstringYesThe area description
SupportCaseCommentsResponse Parameters:
NameParameterData TypeRequiredDescription
SupportCaseIdformintNoThe case id
IdformintNoThe comments id
CommentformstringYesThe case comment
CreatedByformstringYesThe case comment created by
CreatedformDateTimeNoThe case comment created date
SupportCaseAttachmentResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe attachment id
FileUrlformstringYesThe 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

HTTP + JSON

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/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"}]}