Response returned by Web service



The response returned by Web services is a JSON, generally in the following format:

{
    "status": "<status>",
    "data": "<returned data>"
}

Here is what each item returned corresponds:

---

 

status

string

Indicates the status of the request

Possible values: success or error

---

 

data

json

Returns the data of the request

 

---

Empty result

 

If there is no value for the request, the Web service will return the following JSON:

{
    "status" : "success",
    "data": null
}

Errors

 

If you don't use the Content Type application/json in the header Accept, you will receive the following response:

{
    "status": "error",
    "message": "Wrong content type in Accept header
}

If some identification fields are missing in the header, you will receive the following response:

{
    "status": "error",
    "message": "Authentication parameters missing or malformed."
}

If you call a Web service and the login information is not good, or you didn't activate the access right to a Web service in PRIM, you will receive the following response:

 

Example with the Web service newJobCount

{
  "status": "error",
  "data": null,
  "message": "Acces denied::newJobCount:<My IP address>:<My key>:[{\"ParamName\":\"JobType\",\"ParamValue\":\"B\"},{\"ParamName\":\"JobFilled\",\"ParamValue\":\"N\"}]"
}

If you call a Web service (action) that doesn't exist, you will receive the following response:

{
    "status": "error",
    "message": "Action not found in db."
}

If an error in the name of the fields of the JSON that passed through the request occurs, or if you transfer a field that does not exist for a Web service, you will receive the following response:

{
  "status": "error",
  "data": null,
  "message": "incorrect parameter"
}

If the JSON sent to the Web service is malformed, you will receive the following response:

{
  "status": "error",
  "data": null,
  "message": "Invalid JSON sent to request­."
}