BokaMera.API.Host

<back to all web services

SuperAdminUpdateSupportCase

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
PUT/superadmin/support/cases/{Id}Update a support caseUpdate a support case to the company of the currently logged in user, only administrators are allowed to add support cases.
SuperAdminUpdateSupportCase Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?YesEnter the company id, if blank company id and you are an admin, your company id will be used.
IdpathintNoThe support case id
TitlebodystringNoThe case title.
DescriptionbodystringNoThe case description.
CaseTypeIdbodyint?NoIf the case type id.
CaseAreaIdbodyint?NoIf the case area id.
SupportCaseQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe support case id
CompanyUserIdformGuidNoThe company user id
TitleformstringNoThe case title.
DescriptionformstringNoThe case description.
CaseStatusIdformintNoThe case status id.
CaseTypeIdformintNoIf the case type id.
CaseAreaIdformintNoIf the case area id.
CreatedByformstringNoThe case created by.
UpdatedByformstringNoThe case updated by.
SolvedByformstringNoThe case solved by.
UpdatedformDateTimeNoIf case updated date.
CreatedformDateTimeNoIf case created date.
CaseOwnerformstringNoWho owns the support case.
CaseStatusformSupportCaseStatusResponseNoThe case status information.
CaseTypeformSupportCaseTypeResponseNoThe case type information.
CaseAreaformSupportCaseAreaResponseNoThe case area information.
CommentsformList<SupportCaseCommentsResponse>NoThe case comments.
AttachmentsformList<SupportCaseAttachmentResponse>NoThe case attachments.
CaseStatusOptionsformList<SupportCaseStatusResponse>NoThe case status options to select from.
CaseTypeOptionsformList<SupportCaseTypeResponse>NoThe case type options to select from.
CaseAreaOptionsformList<SupportCaseAreaResponse>NoThe case area options to select from.
SupportCaseStatusResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe status id
NameformstringNoThe status name
DescriptionformstringNoThe status description
IconformstringNoThe status icon
ColorformstringNoThe status color
SupportCaseTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe type id
NameformstringNoThe type name
DescriptionformstringNoThe type description
SupportCaseAreaResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe area id
NameformstringNoThe area name
DescriptionformstringNoThe area description
SupportCaseCommentsResponse Parameters:
NameParameterData TypeRequiredDescription
SupportCaseIdformintNoThe case id
IdformintNoThe comments id
CommentformstringNoThe case comment
CreatedByformstringNoThe case comment created by
CreatedformDateTimeNoThe case comment created date
SupportCaseAttachmentResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe attachment id
FileUrlformstringNoThe attachment file url

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: testapi.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
		}
	]
}