i3D.net API Documentation

POST

getInvoiceIds

Get invoice IDs from selection.

Request parameters

Parameter	Type	Description
status	int	0: unpaid, 1: paid, -1: all (optional). Default: -1
dateStart	string	Return invoices dated after this date in format: DD-MM-YYYY (optional). Default: 30 days back from today
dateEnd	string	Return invoices dated before this date in format: DD-MM-YYYY (optional). Default: today

Response parameters

Parameter	Context	Type	Description
invoiceIds		int	The invoice ID

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [invoiceIds] => Array
                (
                    [0] => _INVOICE-ID-1_
                    [1] => _INVOICE-ID-2_
                )

        )

)

POST

getInvoiceDetails

Get an invoice by its ID.

details

Request parameters

Parameter	Context	Type	Description
invoiceId		int	The ID of the invoice

Response parameters

Parameter	Type	Description
number	string	The invoice number (not the same as ID)
title	string	The title of the invoice
description	string	Descriptive text of the purchase
createdOn	date	The date the invoice was created
payBefore	date	The date before which the invoice must be paid
amountNet	float	The invoice amount, including VAT
vat	float	The VAT amount
vatPerc	float	The VAT percentage
status	string	Possible values: "paid" or "unpaid"

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [invoices] => Array
                (
                    [0] => Array
                        (
                            [number] => _INVOICE-NUMBER_
                            [title] => Dell PowerEdge R410 / EU: Rotterdam
                            [description] => Server Type: Dell PowerEdge R410
Location: EU: Rotterdam
Payment Period: 1 month
CPU: 2x Intel(R) Xeon L5630 @ 2.13GHz
Memory: 12 GB DDR3
Harddisks: 2x 250 GB SATA
Operating System: CentOS 5.11
Operating System Bits: 64 Bit
Connectivity: 1 Gbit Connection
Bandwidth: TB Traffic
IP Addresses: 1 IP Address
Service Level Agreement: Office Hours - Priority: Best Effort
RAID Adapter: Hardware RAID
Optical Drive: DVD Drive
                            [createdOn] => 2015-07-07
                            [payBefore] => 2015-08-6
                            [amountNet] => 423.5
                            [vat] => 75.5
                            [vatPerc] => 21
                            [status] => unpaid
                        )

                )

        )

)

POST

getTicketOverview

Get a list of tickets, opened, closed or any status.

details

Request parameters

Parameter	Context	Type	Description
status		int	0: closed, 1: open, 2: forcably closed, -1: all

Response parameters

Parameter	Type	Description
userId	int	The user ID to which the ticket is assigned.
ticketId	int	The ID of the ticket thread.
ticketCode	int	The code of the ticket thread.
created	int	The creation date (unix timestamp).
title	string	The ticket thread title
reference	string	Client reference for this ticket
status	int	0: closed, 1: open, 2: forcably closed
statusUpdateTime	int	The time of the last status update
timeLastUpdated	int	The time of the last reply
priorityId	int	1: Low, 2: Normal, 3: High, 4: Highest (downtime)

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [tickets] => Array
                (
                    [0] => Array
                        (
                            [userId] => _USER-ID_
                            [ticketId] => _TICKET-ID_
                            [ticketCode] => _TICKET-CODE_
                            [created] => 1446202583
                            [title] => A new ticket
                            [reference] => Client ref. 123456-abc
                            [status] => 1
                            [statusUpdateTime] => 1429520483
                            [timeLastUpdated] => 1429520300
                            [priorityId] => 2
                        )

                    [1] => Array
                        (
                            [userId] => _USER-ID_
                            [ticketId] => _TICKET-ID_
                            [ticketCode] => _TICKET-CODE_
                            [created] => 1446648018
                            [title] => test mail to ticket #2
                            [reference] => 
                            [status] => 1
                            [statusUpdateTime] => 1429520483
                            [timeLastUpdated] => 1429520300
                            [priorityId] => 2
                        )

                )

        )

)

POST

getTicket

Get a ticket thread and replies.

details

Request parameters

Parameter	Context	Type	Description
ticketId		int	The ID of the ticket thread

Response parameters

Parameter	Context	Type	Description
ticket		array
ticketId	thread	int	Ticket ID
ticketCode	thread	int	The code of the ticket thread.
userId	thread	int	Ticket user ID
title	thread	string	Ticket title
reference	thread	string	Ticket client reference
status	thread	int	The status of this ticket thread. 0 = closed, 1 = open, 2 = forcably closed
statusUpdateTime	thread	int	The time of the last status update
timeLastUpdated		int	The time of the last reply
priorityId	thread	int	1: Low, 2: Normal, 3: High, 4: Highest (downtime)
replies		array	Container for all replied in this ticket thread
by	replies	string	The real name of the client
userId	replies	int	The client ID
created	replies	int	Reply time
title	replies	string	The title of the reply
content	replies	string	The reply text
attachments	replies	array
attachmentId	attachments	int	The ID of the attachment
name	attachments	string	The file name of the attachment
contentType	attachments	string	Attachment Mime type
size	attachments	int	Attachment size in bytes

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [thread] => Array
                (
                    [ticketId] => _TICKET-ID_
                    [userId] => _USER-ID_
                    [created] => 1446202583
                    [title] => Api created ticket
                    [reference] => Client ref. 123456-abc
                    [status] => 1
                    [statusUpdateTime] => 1429520483
                    [timeLastUpdated] => 1429520300
                    [priorityId] => 2
                )

            [replies] => Array
                (
                    [0] => Array
                        (
                            [by] => John Smith
                            [userId] => _USER-ID_
                            [created] => 1464103858
                            [title] => Api created ticket
                            [content] => This is a ticket with a question
                            [attachments] => Array
                                (
                                    [0] => Array
                                        (
                                            [attachmentId] => 3711
                                            [name] => image.jpg
                                            [contentType] => image/jpeg
                                            [size] => 20025
                                        )

                                )

                        )

                )

        )

)

POST

getTicketAttachment

Get an attachment.

details

Request parameters

Parameter	Context	Type	Description
ticketId		int	The ID of the ticket thread
attachmentId		int	The ID of the attachment

Response parameters

Parameter	Context	Type	Description
ticket		file

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [tickets] => file
        )

)

POST

createTicket

Create a new ticket thread.

details

Request parameters

Parameter	Context	Type	Description
title		string (255)	Title of the new ticket thread
reference		string (64)	Your reference for this ticket
content		string (65535)	Content of the new ticket thread
attachments		array (10)	Max. 10 attachments per post
name	attachments	string (200)	The file name of the attachment
content	attachments	string	Base64 encoded file data
contentType	attachments	string	Mime type of the file
size	attachments	int	The size of the raw, non-encoded file

Response parameters

Parameter	Context	Type	Description
ticketId		int	Returned ticket thread ID

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ticketId] => _TICKET-ID_
        )

)

POST

replyTicket

Reply to an existing ticket thread.

details

Request parameters

Parameter	Type	Description
ticketId	string	The ID of the ticket thread
content	string (65535)	Content of the new ticket reply
attachments	array (10)	array with files, you may upload a max of 10 files
attachment	file	Content-Type: multipart/form-data

Response parameters

Parameter	Context	Type	Description
ticketId		int	Returned ticket thread ID

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ticketId] => _TICKET-ID_
        )

)

POST

openTicket

Open a ticket thread.

details

Request parameters

Parameter	Context	Type	Description
ticketId		int	The ID of the ticket thread

Response parameters

Parameter	Context	Type	Description
ticket		string	Ticket thread has been reopened

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ticket] => Ticket thread 135231 has been reopend
        )

)

POST

closeTicket

Close a ticket thread.

details

Request parameters

Parameter	Context	Type	Description
ticketId		int	The ID of the ticket thread

Response parameters

Parameter	Context	Type	Description
ticket		string	Ticket thread has been closed

Example

Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ticket] => Ticket thread 135231 has been closed
        )

)

Administration

Actions

Tickets