Manuais
PHC GO Get Document Portal Url
 

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": "Bo",
"recordStamp": "z202405141440563140125370"
}

 

Return Information


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

  1. In case of success:


    Returns a URL link to access the document´s Portal GO.

  2. In case of error:


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



JSON Specification for Get new instance



NameTypeObservations
entityStringRequired, must me the table name of entity: Ft, Bo, Re or Po.
recordStampStringRequired, must me the stamp of document.


Examples



Example to obtain URL link to access the document´s Portal GO:
{
"entity":"Bo",
"recordStamp": "z202405141440563140125370"
}