El servicio está basado en una arquitectura REST (en inglés representational state transfer) por lo que puede ser consumido por casi cualquier lenguaje de programación. Asimismo para la transferencia de información se utiliza la estructura de datos JSON (JavaScript Object Notation) debido a que es un formato ligero de intercambio de datos.
Los parámetros están definidos por un Modelo de datos definido en la documentación de cada método. En los métodos de tipo GET esto permite realizar filtros más precisos y búsquedas más complejas. Cada servicio tiene su propio modelo de datos con propiedades de carácter requerido.
En la documentación de los métodos del servicio, se presentará los tipos de parametros recibidos para cada solicitud.
Las respuestas a las solicitudes de los servicios están definidas por un modelo genérico con la siguiente estructura.
{
"Object": {
"AccountId": "string",
"CategoryId": "string",
"Name": "string",
"Code": "string"
},
"Message": {
"Application": "string",
"ErrorMessage": "string",
"Status": "Ok",
"Type": "string"
},
"PartialView": "string"
}
En la propiedad Object del modelo genérico, como se habia mensionado, se encuentra la respuesta a la solicitud del servicio. Para obtener el resultado de la solicitud es necesario validar que Message.Status tenga el valor de Ok, en caso contrario, el valor de Object vendra con valor nulo.
A continuación, se especificará el significado de cada valor de Message.Status:
Ok: La solicitud realizada ha sido satisfactorio y por consiguiente en la propiedad Object vendrá el resultado obtenido de la solicitud y Message.ErrorMessage vendrá vacio.
Warning: La solicitud ha marcado una advertencia por validaciones controladas, la propiedad Object será nulo y Message.ErrorMessage contendrá información correspondiente a la validación realizada.
Danger: La solicitud ha marcado un error no controlado, la propiedad Object será nulo y Message.ErrorMessage contendrá información correspondiente al error no controlado.
En la documentación de cada servicio, se presentará un ejemplo de la respuesta de la solicitud que devolverá la propiedad Object del modelo genérico.