Difference between revisions of "Freeside:3:Documentation:Developer/FS/TicketSystem/RT Internal"

Latest revision as of 13:45, 27 June 2014

customer_tickets CUSTNUM [ LIMIT ] [ PRIORITYVALUE ]

Replacement for the one in RT_External so that we can access custom fields properly.

create_ticket SESSION_HASHREF, OPTION => VALUE ...

Class method. Creates a ticket. If there is an error, returns the scalar error, otherwise returns the newly created RT::Ticket object.

Accepts the following options:

queue

Queue name or Id

subject

Ticket subject

requestor

Requestor email address or arrayref of addresses

cc

Cc: email address or arrayref of addresses

message

Ticket message

mime_type

MIME type to use for message. Defaults to text/plain. Specifying text/html can be useful to use HTML markup in message.

custnum

Customer number (see FS::cust_main) to associate with ticket.

svcnum

Service number (see FS::cust_svc) to associate with ticket. Will also associate the customer who has this service (unless the service is unlinked).

get_ticket SESSION_HASHREF, OPTION => VALUE ...

Class method. Retrieves a ticket. If there is an error, returns the scalar error. Otherwise, currently returns a slightly tricky data structure containing the ticket's attributes, a list of the linked customers, each transaction's content, description, and create time.

Accepts the following options:

ticket_id

The ticket id

get_ticket_object SESSION_HASHREF, OPTION => VALUE...

Class method. Retrieve the RT::Ticket object with the specified ticket_id. If custnum is supplied, will also check that the object is a member of that customer. If there is no ticket or the custnum check fails, returns nothing. The meaning of that case is "to this customer, the ticket does not exist".

Options:

ticket_id

; custnum; correspond_ticket SESSION_HASHREF, OPTION => VALUE ...

Class method. Correspond on a ticket. If there is an error, returns the scalar error. Otherwise, returns the transaction id, error message, and RT::Transaction object.

Accepts the following options:

ticket_id

The ticket id

content

Correspondence content

queues SESSION_HASHREF [, ACL ]

Retrieve a list of queues. Pass the name of an RT access control right, such as 'CreateTicket', to return only queues on which the current user has that right. Otherwise this will return all queues with the 'SeeQueue' right.

selfservice_priority

Returns the configured self-service priority field.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 104:

'=item' outside of any '=over'