Caminho do SalesOne e status das requisições¶
O caminho do WebService é deteminado pelo endereço da URL de chamado. Quando deseja-se que seja feita uma chamada no WebService o endereço e posfixado com “/api/” mais o caminho. Supondo que o endereço do WebService seja http://inventsoftware.info/ e se deseja fazer uma chamada de consulta de parceiro o endereço do webservice será: GET http://inventsoftware.info/api/partner.json e o resultado esperado é um lista de parceiros. Lembre-se que será retornado de acordo com uma paginação, por exemplo, se não for passado os parâmetros da mesma (pageNumber, rowNumber e etc) o SalesOne irá assumir os valores padrões e retornar 100 registros e o número de páginas encontradas.
Todo retorno de um webservice que apresentar algum tipo exceção ou problema, por exemplo erro 400, pode-se consultar os detalhes do retorno na propriedade de Retorno “responseStatus” veja abaixo :
"responseStatus": {
"errorCode": "String",//Código
"errors": [ //Lista de Erros
{
"errorCode": "String",
"fieldName": "String",
"message": "String"
}
],
"message": "String",
"stackTrace": "String"
},
O SalesOne usa o padrão REST, isto siginifica que o mesmo usa os status HTTP para tratar resultado de requisições, a lista de status pode ser facilmente encontrado na internet, vamos citar um exemplo: quando o status for 401 siginifica que o acesso não foi autorizado, 404 siginifica que o recurso (URL) não existe e assim por diante.