Administration

This page describes all the API calls you can make to administer your i3D.net account.
You will always receive the output as described in the documentation below unless an error ocurred. For more information, see the error handling section.

Actions

POST 
getInvoiceIds

Get invoice IDs from selection.


Request parameters
ParameterContextTypeDescription
statusint0: unpaid, 1: paid, -1: all (optional).
Default: -1
dateStartstringReturn invoices dated after this date in format: DD-MM-YYYY (optional).
Default: 30 days back from today
dateEndstringReturn invoices dated before this date in format: DD-MM-YYYY (optional).
Default: today
Response parameters
ParameterContextTypeDescription
invoiceIdsintThe invoice ID

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [invoiceIds] => Array
                (
                    [0] => 150803
                    [1] => 150804
                )

        )

)
POST 
getInvoiceDetails

Get an invoice by its ID.


Request parameters
ParameterContextTypeDescription
invoiceIdintThe ID of the invoice
Response parameters
ParameterContextTypeDescription
numberstringThe invoice number (not the same as ID)
titlestringThe title of the invoice
descriptionstringDescriptive text of the purchase
createdOndateThe date the invoice was created
payBeforedateThe date before which the invoice must be paid
amountNetfloatThe invoice amount, including VAT
vatfloatThe VAT amount
vatPercfloatThe VAT percentage
statusstringPossible values: "paid" or "unpaid"

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [invoices] => Array
                (
                    [0] => Array
                        (
                            [number] => F15-0101091
                            [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
                        )

                )

        )

)

Tickets

POST 
getTicketOverview

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


Request parameters
ParameterContextTypeDescription
statusint0: closed, 1: open, 2: forcably closed, -1: all
Response parameters
ParameterContextTypeDescription
userIdintThe user ID to which the ticket is assigned.
ticketIdintThe ID of the ticket thread.
ticketCodeintThe code of the ticket thread.
createdintThe creation date (unix timestamp).
titlestringThe ticket thread title
referencestringClient reference for this ticket
statusint0: closed, 1: open, 2: forcably closed
statusUpdateTimeintThe time of the last status update
timeLastUpdatedintThe time of the last reply
priorityIdint1: Low, 2: Normal, 3: High, 4: Highest (downtime)

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

                    [1] => Array
                        (
                            [userId] => 113428
                            [ticketId] => 1422
                            [ticketCode] => T-1422-UFSW
                            [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.


Request parameters
ParameterContextTypeDescription
ticketIdintThe ID of the ticket thread
Response parameters
ParameterContextTypeDescription
ticketarray
ticketIdthreadintTicket ID
ticketCodethreadintThe code of the ticket thread.
userIdthreadintTicket user ID
titlethreadstringTicket title
referencethreadstringTicket client reference
statusthreadintThe status of this ticket thread. 0 = closed, 1 = open, 2 = forcably closed
statusUpdateTimethreadintThe time of the last status update
timeLastUpdatedintThe time of the last reply
priorityIdthreadint1: Low, 2: Normal, 3: High, 4: Highest (downtime)
repliesarrayContainer for all replied in this ticket thread
byrepliesstringThe real name of the client
userIdrepliesintThe client ID
createdrepliesintReply time
titlerepliesstringThe title of the reply
contentrepliesstringThe reply text
attachmentsrepliesarray
attachmentIdattachmentsintThe ID of the attachment
nameattachmentsstringThe file name of the attachment
contentTypeattachmentsstringAttachment Mime type
sizeattachmentsintAttachment size in bytes

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [thread] => Array
                (
                    [ticketId] => 4808
                    [userId] => 113428
                    [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] => 113428
                            [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.


Request parameters
ParameterContextTypeDescription
ticketIdintThe ID of the ticket thread
attachmentIdintThe ID of the attachment
Response parameters
ParameterContextTypeDescription
ticketfile

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

)
POST 
createTicket

Create a new ticket thread.


Request parameters
ParameterContextTypeDescription
titlestring (255)Title of the new ticket thread
referencestring (64)Your reference for this ticket
contentstring (65535)Content of the new ticket thread
attachmentsarray (10)Max. 10 attachments per post
nameattachmentsstring (200)The file name of the attachment
contentattachmentsstringBase64 encoded file data
contentTypeattachmentsstringMime type of the file
sizeattachmentsintThe size of the raw, non-encoded file
Response parameters
ParameterContextTypeDescription
ticketIdintReturned ticket thread ID

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ticketId] => 135231
        )

)
POST 
replyTicket

Reply to an existing ticket thread.


Request parameters
ParameterContextTypeDescription
ticketIdstringThe ID of the ticket thread
contentstring (65535)Content of the new ticket reply
attachmentsarray (10)array with files, you may upload a max of 10 files
attachmentfileContent-Type: multipart/form-data
Response parameters
ParameterContextTypeDescription
ticketIdintReturned ticket thread ID

Example
Array
(
    [status] => Success
    [msg] => OK
    [data] => stdClass Object
        (
            [ticketId] => 135231
        )

)
POST 
openTicket

Open a ticket thread.


Request parameters
ParameterContextTypeDescription
ticketIdintThe ID of the ticket thread
Response parameters
ParameterContextTypeDescription
ticketstringTicket 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.


Request parameters
ParameterContextTypeDescription
ticketIdintThe ID of the ticket thread
Response parameters
ParameterContextTypeDescription
ticketstringTicket thread has been closed

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

)