| Card |
|---|
| Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"obrigatorio": 0,
"situacao": 0,
"tamanho": 0,
"tipoDadoComplementar": 0
}
] |
| Column |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|---|
descricao | String | Descrição do dado complementar | Sim | Tamanho máximo: 30 caracteres | | idInquilino | String | Identificador do inquilino | Sim |
| | idProprietario | String | Identificador do proprietário | Sim |
| | idRetaguarda | String | Identificador do dado complementar na retaguarda | Sim | Tamanho máximo: 100 caracteres | | loteOrigem | String | Identificador do lote em que os dados serão enviados | Sim |
| | obrigatorio | Int | Indica se o dado é obrigatório | Sim | 0 - Opcional, 1 - Obrigatório | | situacao | Int | Situação do dado complementar | Sim | 0 - Inativo, 1 - Ativo | | tamanho | Int | Tamanho do dado complementar | Não |
| | tipoDadoComplementar | Int | Tipo do dado complementar | Sim | Código | Tipo |
|---|
| 0 | Alfanumerico | | 1 | Numerico | | 2 | Data | | 3 | ListaSelecao |
|
|
|
Retorno| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
| Card |
|---|
| | Informações |
|---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição| Section |
|---|
| Column |
|---|
| Exemplo de body da requisição[
{
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"obrigatorio": 0,
"situacao": 0,
"tamanho": 0,
"tipoDadoComplementar": 0
}
] |
| Column |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|---|
| descricao | String | Descrição do dado complementar | Não | Tamanho máximo: 30 caracteres | | tipoDadoComplementar | Int | Tipo do dado complementar | Não | | Código | Tipo |
|---|
| 0 | Alfanumerico | | 1 | Numerico | | 2 | Data | | 3 | ListaSelecao |
| | obrigatorio | Int | Indica se o dado é obrigatório | Sim | 0 - Opcional, 1 - Obrigatório | | tamanho | Int | Tamanho do dado complementar | Não |
| | situacao | Int | Situação do dado complementar | Sim | 0 - Inativo, 1 - Ativo | | idInquilino | String | Identificador do inquilino | Sim |
| | idRetaguarda | String | Identificador do dado complementar na retaguarda | Sim |
| | idProprietario | String | Identificador do proprietário | Sim |
| | loteOrigem | String | Identificador do lote em que os dados serão enviados | Sim |
|
|
|
Retornos| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
|
