Mudanças entre as edições de "BMAPI GET api/v1/categoriesTree/(k1Chave)"

De MSTECH wiki
Ir para: navegação, pesquisa
(Criou página com ' == Request == '''Parâmetros''' {| class="wikitable" |- ! Nome ! Descrição ! Tipo |- | k1Chave | Chave k1 do Domínio | String |} '''Corpo''' Não há informação no co...')
 
(→‎Request)
 
(2 revisões intermediárias por um outro usuário não estão sendo mostradas)
Linha 1: Linha 1:
 +
[[BlueMonitorAPI]] > [[BlueMonitorAPI#CategoriesTree|CategoriesTree]]
  
 
== Request ==
 
== Request ==
Linha 17: Linha 18:
  
 
Não há informação no corpo
 
Não há informação no corpo
 +
 +
'''Exemplo'''
 +
 +
http://bluemonitor-teste.devedu.ms/BlueMonitorAPI/api/v1/categoriesTree/2BD9FBE573
  
 
== Response ==
 
== Response ==
Linha 68: Linha 73:
 
| Collection of CategoriesTree
 
| Collection of CategoriesTree
 
|}
 
|}
 +
 +
'''Exemplo'''
 +
{
 +
  "Id": 5,
 +
  "Description": "Bauru",
 +
  "UadId": null,
 +
  "ChildCategoriesTree": [
 +
    {
 +
      "Id": 6,
 +
      "Description": "Secretaria",
 +
      "UadId": null,
 +
      "ChildCategoriesTree": [
 +
        {
 +
          "Id": 6,
 +
          "Description": "Secretaria Municipal de Bauru",
 +
          "UadId": "78feab9f-1659-e311-95c5-b8ac6fb2d553",
 +
          "ChildCategoriesTree": [
 +
            {
 +
              "Id": 7,
 +
              "Description": "Escolas",
 +
              "UadId": "78feab9f-1659-e311-95c5-b8ac6fb2d553",
 +
              "ChildCategoriesTree": [
 +
                {
 +
                  "Id": 7,
 +
                  "Description": "Escola 1",
 +
                  "UadId": "c3a183aa-1659-e311-95c5-b8ac6fb2d553",
 +
                  "ChildCategoriesTree": [
 +
                    {
 +
                      "Id": 8,
 +
                      "Description": "Lab. de Informatica",
 +
                      "UadId": "c3a183aa-1659-e311-95c5-b8ac6fb2d553",
 +
                      "ChildCategoriesTree": null
 +
                    }
 +
                  ]
 +
                },
 +
                {
 +
                  "Id": 7,
 +
                  "Description": "Escola 2",
 +
                  "UadId": "19a283aa-1659-e311-95c5-b8ac6fb2d553",
 +
                  "ChildCategoriesTree": [
 +
                    {
 +
                      "Id": 8,
 +
                      "Description": "Lab. de Informatica",
 +
                      "UadId": "19a283aa-1659-e311-95c5-b8ac6fb2d553",
 +
                      "ChildCategoriesTree": null
 +
                    }
 +
                  ]
 +
                }
 +
              ]
 +
            }
 +
          ]
 +
        }
 +
      ]
 +
    }
 +
  ]
 +
}

Edição atual tal como às 20h20min de 10 de novembro de 2017

BlueMonitorAPI > CategoriesTree

Request

Parâmetros

Nome Descrição Tipo
k1Chave Chave k1 do Domínio String

Corpo

Não há informação no corpo

Exemplo

http://bluemonitor-teste.devedu.ms/BlueMonitorAPI/api/v1/categoriesTree/2BD9FBE573

Response

Http Status Code

Código Nome Descrição
200 OK
412 PreConditionFailed Chave k1 não informada
404 NotFound Chave k1 não encontrada ou estrutura de categorias não encontrada para o domínio
500 InternalServerError Erro inesperado

Corpo

Nome Descrição Tipo
Id Id da categoria integer
Description Descrição da categoria String
UadId Id da Unidade Administrativa Guid
ChildCategoriesTree Lista de categorias filho desta categoria Collection of CategoriesTree

Exemplo 

{
 "Id": 5,
 "Description": "Bauru",
 "UadId": null,
 "ChildCategoriesTree": [
   {
     "Id": 6,
     "Description": "Secretaria",
     "UadId": null,
     "ChildCategoriesTree": [
       {
         "Id": 6,
         "Description": "Secretaria Municipal de Bauru",
         "UadId": "78feab9f-1659-e311-95c5-b8ac6fb2d553",
         "ChildCategoriesTree": [
           {
             "Id": 7,
             "Description": "Escolas",
             "UadId": "78feab9f-1659-e311-95c5-b8ac6fb2d553",
             "ChildCategoriesTree": [
               {
                 "Id": 7,
                 "Description": "Escola 1",
                 "UadId": "c3a183aa-1659-e311-95c5-b8ac6fb2d553",
                 "ChildCategoriesTree": [
                   {
                     "Id": 8,
                     "Description": "Lab. de Informatica",
                     "UadId": "c3a183aa-1659-e311-95c5-b8ac6fb2d553",
                     "ChildCategoriesTree": null
                   }
                 ]
               },
               {
                 "Id": 7,
                 "Description": "Escola 2",
                 "UadId": "19a283aa-1659-e311-95c5-b8ac6fb2d553",
                 "ChildCategoriesTree": [
                   {
                     "Id": 8,
                     "Description": "Lab. de Informatica",
                     "UadId": "19a283aa-1659-e311-95c5-b8ac6fb2d553",
                     "ChildCategoriesTree": null
                   }
                 ]
               }
             ]
           }
         ]
       }
     ]
   }
 ]
}
Disponível em "http://wiki.mstech.com.br/index.php?title=BMAPI_GET_api/v1/categoriesTree/(k1Chave)&oldid=6998"