APIs - Tutoriais

ListLandingPages

20 views 18/08/2021 rodolfo-andrade 0

Lista as landing pages para administração. Se não possuir permissão na ação Visualizar, então o usuário só poderá consultar as suas landing pages.

Payload de entrada:

{
  "searchValue": "string",  // O valor/parâmetro a ser pesquisado no campo título.
  "pagination": {           // Configurações de paginação de uma listagem. Não definido, retornará os 10 primeiros resultados.
    "pageNumber": 0,        // Número/índice da página retornado. A primeira página corresponde ao índice 0
    "pageSize": 0           // Quantidade de registros por página
  }
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/cms/actions​/listLandingPages" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "searchValue": "string", "pagination": { "pageNumber": 0, "pageSize": 0 } }"

Responses:

200 OK
{
  "landingPages": {               // Retorna as páginas, por questões de performance, os papéis em páginas compartilhadas não será retornado
    "id": "string",               // Identificador da landing page no formato landing://{domínio do tenant}/{identificador único da página}
    "pageId": "string",           // Identificador da página
    "title": "string",            // Título da página
    "includeHeader": true,        // Se inclui o header da página com o título
    "landingPageType": "DEFAULT"  // Tipo da landing page
  },
  "listInformation": {            // Informações sobre os resultados de listagem realizada
    "totalElements": 0,           // Quantidade total de resultados encontrados
    "totalPages": 0               // Quantidade total de páginas encontradas
  }
}
Tipos de landing page padrões:

    DEFAULT – “Indica que é uma landing page padrão para caso o usuário não tenha nenhuma landing page compartilhada configurada”
    SHARED – “Indica uma landing page compartilhada com papéis”
    PERSONAL – “Indica que é uma landing page pessoal, somente o usuário que criou conseguirá visualizar”

400 Bad Request (Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente)
{
  "message": "Descrição do erro",
  "errorCode": "codigoDoErro",
  "reason": "BAD_REQUEST",
  "domain": "platform",
  "service": "cms"
}

401 Unauthorized (Usuário ou senha inválido)
{
  "error_description": "Descrição do erro",
  "error": "codigo_do_erro"
}

403 Forbidden (Permissão negada)

Este artigo foi útil para você?