1.1 Definições para campos

De acordo com as definições para JsonSchema, um campo declarado dentro da mensagem deve conter obrigatoriamente as propriedades: 

• type: Indica o tipo de dado do campo, mais detalhes consultar o tópico Tipos de dados padrão.
• description: é importante que a descrição esteja bem detalhada, lembre-se que para o analista que está propondo um campo, o objetivo deste campo é sempre muito óbvio, porém próximos analistas do mesmo produto ou até analistas de outros produtos sempre terão dificuldade caso o campo não esteja bem documentado.
• x-totvs: propriedade customizada com a documentação referente ao campo em cada produto Totvs. 
  • Clique aqui para mais detalhes sobre x-totvs

Padrão de nomenclatura

Os nomes dos campos na mensagem única devem respeitar as regras a seguir:

Nomes escritos em inglês

Procure discutir com outras pessoas com conhecimento da língua inglesa ou pesquisar no Google Translator a tradução correta dos termos. Deve-se prestar muita atenção na possibilidade de ocorrerem os falsos cognatos.

Exemplo: Código do Turno é ShiftCode e não TurnCode e nem CodeOfTurn. Turn em inglês significa: transformar, voltar, vez e não “turno”, é um caso de falso cognato.

Formatação em Upper Camel Case

Devem respeitar a formatação em Upper CamelCase com a primeira letra maiúscula.

Padrão para chaves primárias e estrangeiras simples

Ao criar o elemento que representa a chave primária da mensagem utilize apenas a palavra Code, quando for chave simples.

Ao utilizar uma chave primária como chave estrangeira em outra mensagem, utilize o padrão “Mensagem” + “Code”, ou seja, ItemCode, CustomerCode, BankCode. 

Reaproveitamento de nomes

Deve-se evitar a utilização de nomes diferentes para campos com o mesmo objetivo. Por isso, ao criar os nomes de campos para uma mensagem é importante verificar em outras mensagens qual termo está sendo utilizado para o mesmo objetivo.

Utilize nomes que reflitam a descrição e vice-versa

Tipos de dados padrões

Texto

type: string

"CompanyCode": {
 "type": "string"
}

Propriedades de validação

Numérico

Inteiro

type: integer

format: int32

"BankCode": {
  "description": "Código do banco",
  "type": "integer",
  "format": "int32"
}

Long

type: integer

format: int64

"BankCode": {
  "description": "Código do banco",
  "type": "integer",
  "format": "int64"
}

Float

type: number

format: float

"UnitsPerHour": {
  "type": "number",
  "format": "float"
}

Double

type: number

format: double

"CreditLimit":{
  "type":"number",
  "format":"double"
}

Propriedades de validação

Boleano

type: boolean

"IsPayer":{
  "type":"boolean"
 }

Data

type: string

format: date

"Registerdate":{
  "type": "string",
  "format": "date"
}

Data e Hora

type: string

format: date-time

"Registerdate":{
  "type": "string",
  "format": "date-time"
}

Objeto

type: object

Deve conter o atributo properties, o qual será um objeto com n propriedades.

"CreditInformation": {
    "type": "object",
 	"properties": {
 		"CreditIndicator": {
 			"type": "integer",
 			"format": "int32"
 		}
 	}
}

Para objetos de tipos externos, deve-se utilizar a propriedade $ref, indicando a url do schema desejado, seguido de #/definitions/[nome do schema].

"CommunicationInformation": {
	"$ref": "https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/types/ContactInformation_1_000.json#/definitions/CommunicationInformationType",
	"description": "Informações para Contato",
	"type": "object"
}

Array

type: array

Deve conter o atributo items, o qual deverá conter uma das seguintes opções:

"type":"array",
"items": {
   "type": "string"
}

"type":"array",
"items": {
    "properties": {
          "bankCode": {
          	"note": "Código do banco",
          	"type": "integer",
          	"format": "int32"
		   }
	}
}

"type":"array",
"items":{
	"$ref": "https://github.com/totvs/ttalk-standard-message/blob/master/jsonschema/schemas/types/Address_2_000.json/#/definitions/AddressType"
}

Propriedades de validação

Obrigatoriedade

No arquivo do JsonSchema, as propriedades devem ser definidas como não obrigatórias, pois as mensagens únicas são utilizadas tanto para inclusão quando para exclusão. Ou seja, uma exclusão não precisa enviar tantas informações quanto a inclusão. Se a mensagem única tivesse os seus campos obrigatórios geraria a necessidade de se enviar o registro completo para exclusão e não apenas a sua chave.

Além disso, a obrigatoriedade de um campo depende de cada produto, o que torna muito mais difícil chegar a um consenso se for necessário considerar esta característica na modelagem da mensagem.

Por isso, ao declarar o schema, não se deve inserir a propriedade required para os campos.

Campos que se repetem poderão apresentar um padrão diferente, consulte o tópico criando listas de valores e elementos para mais informações.

Havendo a necessidade de validação da presença ou não de informação na mensagem, este controle deve ser feito no próprio adapter.

Campos de código + descrição

Não é necessário montar mensagens específicas para tabelas que só precisarão trafegar código e descrição. Estas informações poderão trafegar como chave estrangeira na mensagem que as utilizar. Também não é necessário criar agrupadores específicos para estes campos, podem ser colocados na raiz das mensagens.

Exemplo: Considere, hipoteticamente, que a entidade Item esteja relacionada à informação do fabricante.

Não existe a necessidade de criar a mensagem Manufacturer (supondo que contém apenas Código + Descrição). Estes dados deverão ser enviados na mensagem de Item.

Campos com valores fixos

Campos com valores fixos devem ser definidos com tipo String e seus valores devem ser uma sequência numérica (1,2,3,4 etc...). O objetivo desta definição é evitar confusões pelo uso de letras iguais para objetivos diferentes entre os produtos TOTVS. Exemplo: RM, Pedido Cancelado = “C”; Datasul, Pedido Concluído = “C”. Utilizando sempre a sequência numérica o desenvolvedor se vê obrigado a observar a lista de valores presentes na mensagem, observando inclusive se o tipo que queira utilizar já está listado na definição da mensagem.

Porém, há casos em que um campo em um produto é composto por uma lista fixa de valores, enquanto em outro produto esses valores podem ser cadastrados dinamicamente. Exemplo: Tipo do documento no Logix é fixo; no Protheus é pre-cadastrado e permite alterar; no Datasul é fixo e no RM é totalmente cadastrável. Para estes casos leia o tópico Conflito entre valores fixos e valores cadastráveis.

"SubscriptionType": {
	"type": "string",
	"example": "1",
	"description": "Tipo de inscrição",
	"enum": ["1",
	"2",
	"3",
	"4"],
	"x-totvs": [{
		"product": "protheus",
		"field": "SM0.M0_TPINSC",
		"required": false,
		"type": "Char",
		"length": "1",
		"available": true,
		"canUpdate": false,
		"note": "1=CEI;2=CNPJ;3=CPF;4=INCRA"
	}]
}

Referências

https://tools.ietf.org/html/draft-wright-json-schema-validation-00

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#dataTypes