com.iland.core.web.rest.api

Interface CompanySupportResource

@Path(value="/companies/{companyId}/support-tickets")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface CompanySupportResource

Support Resource API.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
SupportTicketAttachmentDetailsResponse	addTicketAttachment(String companyId, int ticketId, SupportTicketAttachmentCreateRequest attachment) Add an attachment to a support ticket.
SupportTicketCommentResponse	addTicketComment(String companyId, int ticketId, SupportTicketCommentCreateRequest newComment) Add a comment to a support ticket.
SupportTicketResponse	createSupportTicket(String companyId, SupportTicketCreateRequest newSupportTicket) Add a new support ticket.
SupportRegardingOptionListResponse	getRegardingOptions(String companyId) Return a list of regarding options, service options, and categories applicable to opening support tickets.
InputStream	getTicketAttachment(String companyId, int ticketId, int attachmentId) Get the file attached to a support ticket.
SupportTicketAttachmentDetailsListResponse	getTicketAttachmentList(String companyId, int ticketId) Get a list of files attached to the support ticket.
SupportTicketResponse	getTicketById(String companyId, int ticketId) Get a support ticket by its ID.
SupportTicketCommentListResponse	getTicketComments(String companyId, int ticketId) Get support ticket comments for a specified support ticket.
SupportTicketListResponse	getTicketsForCompany(String companyId, Integer offset, Integer limit) Get all support tickets for a company.
IsAttachmentDownloadableResponse	isAttachmentDownloadable(String companyId, int ticketId, int attachmentId) Return whether the attachment is available for download.
SupportTicketResponse	updateSupportTicket(String companyId, int ticketId, SupportTicketUpdateRequest supportTicket) Updates a support ticket.

Method Detail

createSupportTicket

@POST
 @Consumes(value="application/json")
SupportTicketResponse createSupportTicket(@PathParam(value="companyId")
                                                                                     String companyId,
                                                                                     SupportTicketCreateRequest newSupportTicket)

Add a new support ticket.

'regarding_id' (required) : is what the ticket is regarding. 'service_id' (required) : refers to the specific service option. 'category_id' (optional) : the category option of the service.

Find the regarding, service and category ids by using the getRegardingOptions(String) method.

Parameters:

companyId - company identifier

newSupportTicket - specification for adding a new support ticket

Returns:

details of new support request

updateSupportTicket

@PUT
 @Path(value="/{ticketId}")
 @Consumes(value="application/json")
SupportTicketResponse updateSupportTicket(@PathParam(value="companyId")
                                                                                                                String companyId,
                                                                                                                @PathParam(value="ticketId")
                                                                                                                int ticketId,
                                                                                                                SupportTicketUpdateRequest supportTicket)

Updates a support ticket. Note that all properties are read-only except for 'cc_email_addresses' and 'cc_emails_enabled'.

Parameters:

companyId - company identifier

ticketId - the id of the ticket to update

supportTicket - updated support ticket

Returns:

details of the support ticket after the update

addTicketComment

@POST
 @Path(value="/{ticketId}/comments")
 @Consumes(value="application/json")
SupportTicketCommentResponse addTicketComment(@PathParam(value="companyId")
                                                                                                                              String companyId,
                                                                                                                              @PathParam(value="ticketId")
                                                                                                                              int ticketId,
                                                                                                                              SupportTicketCommentCreateRequest newComment)

Add a comment to a support ticket.

Parameters:

companyId - the company identifier

newComment - specification for adding a new new support ticket comment

ticketId - support request ID

getTicketById

@GET
 @Path(value="/{ticketId}")
SupportTicketResponse getTicketById(@PathParam(value="companyId")
                                                                     String companyId,
                                                                     @PathParam(value="ticketId")
                                                                     int ticketId)

Get a support ticket by its ID.

Parameters:

companyId - the company identifier

ticketId - support ticket id

Returns:

support request

getTicketsForCompany

@GET
SupportTicketListResponse getTicketsForCompany(@PathParam(value="companyId")
                                                    String companyId,
                                                    @QueryParam(value="offset")
                                                    Integer offset,
                                                    @QueryParam(value="limit")
                                                    Integer limit)

Get all support tickets for a company.

Parameters:

companyId - the company identifier

offset - the page number

limit - the page size (maximum is 100)

Returns:

support tickets

getTicketComments

@GET
 @Path(value="/{ticketId}/comments")
SupportTicketCommentListResponse getTicketComments(@PathParam(value="companyId")
                                                                                             String companyId,
                                                                                             @PathParam(value="ticketId")
                                                                                             int ticketId)

Get support ticket comments for a specified support ticket.

Parameters:

companyId - the company identifier

ticketId - support request ID

Returns:

list of support request conversation replies

addTicketAttachment

@POST
 @Path(value="/{ticketId}/attachments")
 @Consumes(value="multipart/form-data")
SupportTicketAttachmentDetailsResponse addTicketAttachment(@PathParam(value="companyId")
                                                                                                                                                 String companyId,
                                                                                                                                                 @PathParam(value="ticketId")
                                                                                                                                                 int ticketId,
                                                                                                                                                 SupportTicketAttachmentCreateRequest attachment)

Add an attachment to a support ticket.

Parameters:

companyId - the company identifier

attachment - multipart form input

ticketId - the support ticket ID to attach file to

Returns:

summary of attachment

getTicketAttachmentList

@GET
 @Path(value="/{ticketId}/attachments")
SupportTicketAttachmentDetailsListResponse getTicketAttachmentList(@PathParam(value="companyId")
                                                                                                                String companyId,
                                                                                                                @PathParam(value="ticketId")
                                                                                                                int ticketId)

Get a list of files attached to the support ticket.

Parameters:

companyId - the company identifier

ticketId - support ticket ID

Returns:

summary of files attached to a support ticket

getTicketAttachment

@GET
 @Path(value="/{ticketId}/attachments/{attachmentId}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+octet-stream")
InputStream getTicketAttachment(@PathParam(value="companyId")
                                                                                                                                                                 String companyId,
                                                                                                                                                                 @PathParam(value="ticketId")
                                                                                                                                                                 int ticketId,
                                                                                                                                                                 @PathParam(value="attachmentId")
                                                                                                                                                                 int attachmentId)

Get the file attached to a support ticket.

Parameters:

companyId - the company identifier

ticketId - support ticket ID

attachmentId - attachment ID

Returns:

file attached to a support request

isAttachmentDownloadable

@GET
 @Path(value="/{ticketId}/attachments/{attachmentId}/is-downloadable")
IsAttachmentDownloadableResponse isAttachmentDownloadable(@PathParam(value="companyId")
                                                                                                                                      String companyId,
                                                                                                                                      @PathParam(value="ticketId")
                                                                                                                                      int ticketId,
                                                                                                                                      @PathParam(value="attachmentId")
                                                                                                                                      int attachmentId)

Return whether the attachment is available for download. (Some files are quarantined by anti-virus and are not downloadable).

Parameters:

companyId - companyId ID

ticketId - ticket ID

attachmentId - attachment ID

Returns:

whether attachment is downloadable

getRegardingOptions

@GET
 @Path(value="/regarding-options")
SupportRegardingOptionListResponse getRegardingOptions(@PathParam(value="companyId")
                                                                                               String companyId)

Return a list of regarding options, service options, and categories applicable to opening support tickets.

Returns:

regarding options