Consulta de Àreas de Atividades – GET

Filtros


Atalhos para busca

Objetivo

A finalidade deste método é, possibilitar a consulta de áreas de atividades.

Chamada

GET api/v1/sm/activity-areas?ACTIVITY_AREA=
{ACTIVITY_AREA}&ALTERNATIVE_CODE=
{ALTERNATIVE_CODE}&_pageNo=
{_pageNo}&_pageSize=
{_pageSize}

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
activity_area Activity Area Description – (Optional) string Tamanho da string: inclusive between 0 and 35
alternative_code Alternative Code – (Optional) string Tamanho da String: inclusive between 0 and 20
_pageNo integer Não há.
_pageSize integer Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (200)
  • NotFound (404)
  • BadRequest (400)
  • Unauthorized (401)
  • InternalServerError (500)

Descrição do Recurso (Resource Description)

ActivityAreasResponseDTO – List of Activity Areas

Collection of ActivityAreasResponseDTO

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
activity_area Activity Area Description string Não há.
activity_area_code Activity Area Code string Não há.
alternative_code Alternative Code string Não há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "activity_area": "sample string 1",
    "activity_area_code": "sample string 2",
    "alternative_code": "sample string 3"
  },
  {
    "activity_area": "sample string 1",
    "activity_area_code": "sample string 2",
    "alternative_code": "sample string 3"
  }
]

application/xml, text/xml

Exemplo (Sample):

<ArrayOfActivityAreasResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Common">
  <ActivityAreasResponseDTO>
    <ACTIVITY_AREA>sample string 1</ACTIVITY_AREA>
    <ACTIVITY_AREA_CODE>sample string 2</ACTIVITY_AREA_CODE>
    <ALTERNATIVE_CODE>sample string 3</ALTERNATIVE_CODE>
  </ActivityAreasResponseDTO>
  <ActivityAreasResponseDTO>
    <ACTIVITY_AREA>sample string 1</ACTIVITY_AREA>
    <ACTIVITY_AREA_CODE>sample string 2</ACTIVITY_AREA_CODE>
    <ALTERNATIVE_CODE>sample string 3</ALTERNATIVE_CODE>
  </ActivityAreasResponseDTO>
</ArrayOfActivityAreasResponseDTO>

 

Este artigo foi útil para você?
Sim
Não
Confirmar que o artigo não foi útil