assistance-engine/docs/developer.avapframework.com/Obtener_caracteristicas_de_...

3.5 KiB

This service is used to obtain the users' profiles.

GET: URL_BASE + /ws/util.py/get_caracteristicas

Receives:

All parameters are sent in the querystring of the call, so a percentage encoding for URI must be applied (aka URL encoding).

Returns:

Depending on the result of the operation, this service can return two different JSON:

Answer JSON OK:

{
         "status"
        : <boolean>
        ,
         "characteristics"
        :{' '}
        {
         }
        ,
         "elapsed"
        : <float>
         }

Where:

  • status: Shows if the call has been successful (true) or not (false).
  • characteristics: Container object of the characteristics of the indicated service.
  • elapsed: Operation execution time.

Answer JSON KO:

{
         "status"
        :{' '}
        false
        ,
         "level"
        : <string>
        ,
         "message"
        : <string>
        ,
         "error"
        : <string>
         }

Where:

  • status: Shows if the call has been successful (true) or not (false).
  • level: Error importance level.
  • message: Error message.
  • error: Sole error code.

Example requests:

Python - Requests:

import requests
         url ={' '}
        
          "URL_BASE/ws/util.py/get_caracteristicas?country_code=MX&user_id=4532&session_id=413-JRdxDQvO-zPMcwLeptmOyA==&point_of_entry=login"
        
         payload ={' '}
        {
        }
         files ={' '}
        {
        }
         headers={' '}
        {
        }
         response = requests
        .request
        (
        "GET"
        , url
        , headers
        =headers
        , data{' '}
        = payload
        , files{' '}
        = files
        )
         print
        (response
        .text
        .encode
        (
        'utf8'
        )
        )

NodeJs - Request:

var request = require('request');
         var options = {
         'method': 'GET',
         'url':
        'URL_BASE/ws/util.py/get_caracteristicas?country_code=MX&user_id=4532&session_id=413-JRdxDQvO-zPMcwLeptmOyA==&point_of_entry=login',
         'headers': {},
         formData: {}
         };
         request(options, function (error, response) {{' '}
         if (error) throw new Error(error);
         console.log(response.body);
         });

JavaScript - Fetch:

var formdata = new FormData();
         var requestOptions = {
         method: 'GET',
         body: formdata,
         redirect: 'follow'
         };
        {' '}
        fetch("URL_BASE/ws/util.py/get_caracteristicas?country_code=MX&user_id=4532&session_id=413-JRdxDQvO-zPMcwLeptmOyA==&point_of_entry=login",
        requestOptions)
         .then(response => response.text())
         .then(result => console.log(result))
         .catch(error => console.log('error', error));

CURL:

curl --location --request GET{' '}
        
          'URL_BASE/ws/util.py/get_caracteristicas?country_code=MX /{' '}
          &user_id=4532&session_id=413-JRdxDQvO-zPMcwLeptmOyA%3D%3D&point_of_entry=login'

Business logic:

In order to make this call it is necessary to make it with a user who is logged into the system, except for the following entry points:

  • registration
  • login
  • restartpin
  • forwardotpregistration

Each element of the answer that is within the characteristics is formed with the following structure:

being the value of the property of any type.