Home

Série 1

Páginas filhas
  • ProductImage

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Esta entidade exibe informações sobre a imagem dos produtos e suporta as seguintes operações: GETPOSTPUT e DELETE.

 

Campos do retorno

Nome

Descrição

Tamanho do campo

Tipo

Mais detalhes

productId

Identificação do produto

15

Caracter

-

Id

Identificação da imagem

4

Caracter

Gerado sequencialmente para um mesmo produto

hash

Código hash da imagem

32

Caracter

Algoritmo MD5 (Message Digest Algorithm 5), tipo 2 (Hexadecimal)

type

Tipo da imagem

3

Caracter

PNG, BMP, etc

size

Tamanho

8

Numérico

Tamanho em bytes da imagem

description

Descrição

50

Caracter

Texto livre

image

Imagem

-

url

url (ver maiores detalhes abaixo em url)

 

Exemplo de obtenção de informações específicas sobre a imagem de determinado produto:

/first/api/v1/productImage/00011,0001

{

  "pk": "00011,0001",

  "productId": "00011",

  "id": "0001",

  "hash": "cb0021025dabce987cee7be5f1e66f99",

  "type": "PNG",

  "size": 13237,

  "description": "",

  "image": {

    "url": "/first/api/v1/productImage/00011,0001/image"

  }

}

 

url – ao clicar na url e enviar a requisição, será retornada a imagem do produto.

 

Exemplo de inclusão e exclusão de registros

Para adicionar uma nova imagem a um produto deve-se usar o método de POST, e no campo de requisição informar os campos necessários para inclusão. Observação: Para a alteração basta mudar o método para PUT e então realizar o mesmo procedimento abaixo. O campo da imagem deve ser uma string de 64 bytes, conforme as especificações RFC para base 64. Não será demonstrado nesse documento devido ao tamanho da string ser muito longa.

 

 - Inclusão

{

"productId" : "00011",

"type": "png",

"image": "",

"description": "Imagem de testes"

}

Retorno:

{

  "url": "/first/api/v1/productimage/00011,0004",

  "productId": "00011",

  "id": "0004"

}

 

Para excluir uma imagem deve-se usar o método de DELETE, e informar o registro que deve ser excluído, via URL

 

Retorno:

{

  "url": "/first/api/v1/productimage/00011,0001",

  "productId": "00011",

  "id": "0001"

}