Search Knowledge Base Articles

API of PMP CRM

Ticket

Ticket - Add New Ticket

0.0.0 
POST 
api/tickets

Header

Field Type Description
Authorization String

Basic Access Authentication token.

Parameter

Field Type Description
subject String

Mandatory Ticket name .
department String

Mandatory Ticket Department.
contactid String

Mandatory Ticket Contact.
userid String

Mandatory Ticket user.
project_idoptional String

Optional Ticket Project.
messageoptional String

Optional Ticket message.
serviceoptional String

Optional Ticket Service.
assignedoptional String

Optional Assign ticket.
ccoptional String

Optional Ticket CC.
priorityoptional String

Optional Priority.
tagsoptional String

Optional ticket tags.

{Multipart Form} Request-Example:

array (size=11)
 'subject' => string 'ticket name' (length=11)
 'contactid' => string '4' (length=1)
 'userid' => string '5' (length=1)
 'department' => string '2' (length=1)
 'cc' => string '' (length=0)
 'tags' => string '' (length=0)
 'assigned' => string '8' (length=1)
 'priority' => string '2' (length=1)
 'service' => string '2' (length=1)
 'project_id' => string '' (length=0)
 'message' => string '' (length=0)

Success 200

Field Type Description
status Boolean

Request status.
message String

Ticket add successful.

Success-Response:

HTTP/1.1 200 OK
{
  "status": true,
  "message": "Ticket add successful."
}

Error 4xx

Name Type Description
status Boolean

Request status.
message String

Ticket add fail.

Error-Response:

HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Ticket add fail."
}

Ticket - Delete a Ticket

DELETE 
api/delete/tickets/:id

Header

Field Type Description
Authorization String

Basic Access Authentication token.

Parameter

Field Type Description
id Number

Ticket unique ID.

Success 200

Field Type Description
status Boolean

Request status.
message String

Ticket Delete Successful.

Success-Response:

HTTP/1.1 200 OK
{
  "status": true,
  "message": "Ticket Delete Successful."
}

Error 4xx

Name Type Description
status Boolean

Request status.
message String

Ticket Delete Fail.

Error-Response:

HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Ticket Delete Fail."
}

Ticket - Request Ticket information

GET 
api/tickets/:id

Header

Field Type Description
Authorization String

Basic Access Authentication token.

Parameter

Field Type Description
id Number

Ticket unique ID.

Success 200

Field Type Description
Ticket Object

information.
  • Success-Response:
HTTP/1.1 200 OK
{
    "ticketid": "7",
    "adminreplying": "0",
    "userid": "0",
    "contactid": "0",
    "email": null,
    "name": "Trung bình",
    "department": "1",
    "priority": "2",
    "status": "1",
    "service": "1",
    "ticketkey": "8ef33d61bb0f26cd158d56cc18b71c02",
    "subject": "Ticket ER",
    "message": "Ticket ER",
    "admin": "5",
    "date": "2019-04-10 03:08:21",
    "project_id": "5",
    "lastreply": null,
    "clientread": "0",
    "adminread": "1",
    "assigned": "5",
    "line_manager": "8",
    "milestone": "27",
    ...
}

Error 4xx

Name Type Description
status Boolean

Request status.
message String

The id of the Ticket was not found.
  • Error-Response:
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "No data were found"
}

Ticket - Search Ticket Information

GET 
api/tickets/search/:keysearch

Header

Field Type Description
Authorization String

Basic Access Authentication token.

Parameter

Field Type Description
keysearch String

Search keywords.

Success 200

Field Type Description
Ticket Object

information.
  • Success-Response:
HTTP/1.1 200 OK
{
    "ticketid": "7",
    "adminreplying": "0",
    "userid": "0",
    "contactid": "0",
    "email": null,
    "name": "Trung bình",
    "department": "1",
    "priority": "2",
    "status": "1",
    "service": "1",
    "ticketkey": "8ef33d61bb0f26cd158d56cc18b71c02",
    "subject": "Ticket ER",
    "message": "Ticket ER",
    "admin": "5",
    "date": "2019-04-10 03:08:21",
    "project_id": "5",
    "lastreply": null,
    "clientread": "0",
    "adminread": "1",
    "assigned": "5",
    "line_manager": "8",
    "milestone": "27",
    ...
}

Error 4xx

Name Type Description
status Boolean

Request status.
message String

The id of the Ticket was not found.
  • Error-Response:
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "No data were found"
}

Ticket - Update a ticket

0.0.0 
PUT 
api/tickets/:id

Header

Field Type Description
Authorization String

Basic Access Authentication token.

Parameter

Field Type Description
subject String

Mandatory Ticket name .
department String

Mandatory Ticket Department.
contactid String

Mandatory Ticket Contact.
userid String

Mandatory Ticket user.
priority String

Mandatory Priority.
project_idoptional String

Optional Ticket Project.
messageoptional String

Optional Ticket message.
serviceoptional String

Optional Ticket Service.
assignedoptional String

Optional Assign ticket.
tagsoptional String

Optional ticket tags.
  • Request-Example:
{
    "subject": "Ticket ER",
    "department": "1",
    "contactid": "0",
    "ticketid": "7",
    "userid": "0",
    "project_id": "5",
    "message": "Ticket ER",
    "service": "1",
    "assigned": "5",
    "priority": "2",
    "tags": ""
}

Success 200

Field Type Description
status Boolean

Request status.
message String

Ticket Update Successful.
  • Success-Response:
HTTP/1.1 200 OK
{
  "status": true,
  "message": "Ticket Update Successful."
}

Error 4xx

Name Type Description
status Boolean

Request status.
message String

Ticket Update Fail.
  • Error-Response:
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Ticket Update Fail."
}

Did you find this article useful?

Related Articles