CMS - ListFactoryDefaultLandingPages

  • Fri, 09/03/2021 - 09:58
  • /giovani.lisboa@...

Lista as landing pages padrões de fábrica.

Payload de entrada:

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

Exemplo de request:

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

Responses:

200 OK

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

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