Resposta

Ao chamar esta rota na API, você obterá uma resposta específica dependendo do status da solicitação.

A estrutura da resposta é sempre a mesma com a seguinte estrutura:

{
     "success": bool,
     "data": Data Object,
     "error": Error Object,
     "pagination": Pagination Object
}

Objetos de Resposta

success

• true: A solicitação foi bem-sucedida. O objeto error será um ditado vazio {}.
• false: A solicitação não foi bem-sucedida. Mais informações sobre o erro podem ser encontradas no objeto error.

data

Este objeto armazenará os dados no caso de uma solicitação bem-sucedida. Sempre conterá user_id ou account_id e todos os outros campos serão dinâmicos, de acordo com a rota que você chamou.

Campos dinâmicos:

• country: O país da conta do usuário.
• platform: A plataforma da conta do usuário.
• message: Informação fornecida em caso de falha na conexão.
• perfil: Dados do perfil do usuário. Consulte a seção Perfil para obter mais informações.
• earnings: (Gig economy) Ganhos do usuário. Consulte a seção Ganhos para obter mais informações.
• employment: (Empregos formais) Histórico profissional do usuário. Consulte a seção Emprego para obter mais informações.

error

Este objeto conterá informações de erro no caso de falha na solicitação.

"error": {
     "code": str,
     "message": str,
     "errors": [{
          "message": str,
          "location": str
     }]
}

Para obter mais informações sobre possíveis erros, consulte a seção Erros.

pagination

Este objeto só será incluído na resposta para rotas onde a paginação é utilizada, como:

• POST /accounts/:account_id/earnings/search
• POST /accounts

"pagination": {
     "page": 1,
     "items_per_page": 50,
     "total_items": 200,
     "total_pages": 4
}

O valor padrão para items_per_page é 100, a menos que um valor diferente seja especificado na carga útil da solicitação.