Árvore de páginas

Objetivo

A finalidade deste método é, possibilitar a consulta de locais para inventário.

Chamada

GET api/v1/sm/inventories/places?numberCompany=
{numberCompany}&placeCode=
{placeCode}&changedDate=
{changedDate}&_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)
numberCompanyNumber CompanyintegerNão há.
placeCodePlace Code (Optional: If it is not filled, the code of the place will not be considered. Otherwise, the records with the code of the place will be considered equal to a certain code)integerNão há.
changedDateChanged Date dd/MM/yyyy HH:mm or ddMMyyyyHHmm (Optional: If it is not filled, the date will not be considered. Otherwise, will be considered the records with date equal to a certain date)stringNão há.
_pageNo
integerNão há.
_pageSize
integerNã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)

List of PlacesResponseDTO

Collection of PlacesResponseDTO

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
numberCompanyNumber CompanyintegerNão há
placeCodePlace CodeintegerNão há
placePlacestringNão há
statusStatusstringNão há
changedDateChanged DatedateNão há

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "numberCompany": 1,
    "placeCode": 2,
    "place": "sample string 3",
    "status": "sample string 4",
    "changedDate": "2019-10-23T16:29:34.1790667-03:00"
  },
  {
    "numberCompany": 1,
    "placeCode": 2,
    "place": "sample string 3",
    "status": "sample string 4",
    "changedDate": "2019-10-23T16:29:34.1790667-03:00"
  }
]

application/xml, text/xml

Exemplo (Sample):

<ArrayOfPlacesResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1">
  <PlacesResponseDTO>
    <changedDate>2019-10-23T16:29:34.1790667-03:00</changedDate>
    <numberCompany>1</numberCompany>
    <place>sample string 3</place>
    <placeCode>2</placeCode>
    <status>sample string 4</status>
  </PlacesResponseDTO>
  <PlacesResponseDTO>
    <changedDate>2019-10-23T16:29:34.1790667-03:00</changedDate>
    <numberCompany>1</numberCompany>
    <place>sample string 3</place>
    <placeCode>2</placeCode>
    <status>sample string 4</status>
  </PlacesResponseDTO>
</ArrayOfPlacesResponseDTO>