Manuais
PHC GO Fetch Records (Advanced Filter)
 

Method


The method to be called is:



Parameters


In the request headers the Authorization header must have the Access Token:

  • Authorization: {{accessToken}}


JSON body


In the body of the POST a JSON structure like this one has to be passed:

{
"entity": "entityName",
"filterItem": [
{
"comparison": 0,
"filterItem": "ndoc",
"valueItem": 1
},
{
"comparison": 0,
"filterItem": "draftRecord",
"valueItem": 0
}
]
}

 

Return Information


Any call made to this method will return a JSON information with this structure:

  1. In case of success:


    Returns a JSON with an Array of entity objects of the entity requested saved in PHC GO

  2. In case of error:


    {
    "code": 100,
    "message": "Error message"
    }


 

JSON Specification for Fetch Records (Advanced Filter)



NameTypeObservations
entityStringRequired, must me the table name of entity for example: Cl, Ft, Re, etc

If the request is an addon table, must be passed like this: uXXXX_table_name.
filterItemStringFilter parameter, which can be built according to basic parameters (for example: filterItem, valueItem, comparison, groupItem, etc.)