Acl
GET /acl
https://apisafe.alweb.com.br/acl
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| permissao | string | Status da permissão (allow ou deny) |
YES |
| perfil | inteiro | Id do perfil |
YES |
| resource | integer | id do recurso |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/acl?page=1"
},
"first": {
"href": "https://apisafe.alweb.com.br/acl"
},
"last": {
"href": "https://apisafe.alweb.com.br/acl?page=10"
},
"next": {
"href": "https://apisafe.alweb.com.br/acl?page=2"
}
},
"_embedded": {
"acl": [
{
"id": 12,
"permissao": "allow",
"_embedded": {
"perfil": {
"id": 3,
"nome": "Expositor",
"perfilId": 2,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/perfil/3"
}
}
},
"resource": {
"id": 18,
"nome": "User\\Controller\\Login.index",
"label": "Página de login",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/resource/18"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/acl/12"
}
}
},
]
},
"page_count": 10,
"page_size": 25,
"total_items": 246,
"page": 1
}
POST /acl
https://apisafe.alweb.com.br/acl
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| permissao | string | Status da permissão (allow ou deny) |
YES |
| perfil | inteiro | Id do perfil |
YES |
| resource | integer | id do recurso |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"permissao": "allow ou deny",
"perfil": "Id do perfil",
"resource": "id do recurso"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"id": 314,
"permissao": "allow",
"_embedded": {
"perfil": {
"id": 3,
"nome": "Expositor",
"perfilId": 2,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/perfil/3"
}
}
},
"resource": {
"id": 18,
"nome": "User\\Controller\\Login.index",
"label": "Página de login",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/resource/18"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/acl/314"
}
}
}
GET /acl[/:acl_id]
https://apisafe.alweb.com.br/acl/id_acl
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| permissao | string | Status da permissão (allow ou deny) |
YES |
| perfil | inteiro | Id do perfil |
YES |
| resource | integer | id do recurso |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"id": 314,
"permissao": "deny",
"_embedded": {
"perfil": {
"id": 3,
"nome": "Expositor",
"perfilId": 2,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/perfil/3"
}
}
},
"resource": {
"id": 18,
"nome": "User\\Controller\\Login.index",
"label": "Página de login",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/resource/18"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/acl/314"
}
}
}
PATCH /acl[/:acl_id]
Metodo não disponível
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| permissao | string | Status da permissão (allow ou deny) |
YES |
| perfil | inteiro | Id do perfil |
YES |
| resource | integer | id do recurso |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /acl[/:acl_id]
https://apisafe.alweb.com.br/acl/id_acl
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| permissao | string | Status da permissão (allow ou deny) |
YES |
| perfil | inteiro | Id do perfil |
YES |
| resource | integer | id do recurso |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"permissao": "allow ou deny",
"perfil": "Id do perfil",
"resource": "id do recurso"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"id": 314,
"permissao": "deny",
"_embedded": {
"perfil": {
"id": 3,
"nome": "Expositor",
"perfilId": 2,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/perfil/3"
}
}
},
"resource": {
"id": 18,
"nome": "User\\Controller\\Login.index",
"label": "Página de login",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/resource/18"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/acl/314"
}
}
}
DELETE /acl[/:acl_id]
https://apisafe.alweb.com.br/acl/id_acl
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| permissao | string | Status da permissão (allow ou deny) |
YES |
| perfil | inteiro | Id do perfil |
YES |
| resource | integer | id do recurso |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
AgendaMensagem
Agendamento para envio de newsletter
GET /agendamensagem
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 60 caracteres |
YES |
| data_start | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| data_end | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| tipo_mensagem | inteiro | id da categoria |
YES |
| color | string | hexadecimal (#000000) |
NO |
| mensagem_sms | inteiro | id mensagem sms |
NO |
| user_inc | inteiro | id usuário |
YES |
| user_upd | inteiro | id do usuário |
YES |
| mensagem | inteiro | id do template |
YES |
| evento | text | Id do Evento |
YES |
| destino_mensagem | text | YES | |
| data_inc | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/agendamensagem"
},
"first": {
"href": "/agendamensagem?page={page}"
},
"prev": {
"href": "/agendamensagem?page={page}"
},
"next": {
"href": "/agendamensagem?page={page}"
},
"last": {
"href": "/agendamensagem?page={page}"
}
}
"_embedded": {
"agenda_mensagem": [
{
"_links": {
"self": {
"href": "/agendamensagem[/:agenda_mensagem_id]"
}
}
"nome": "Max. 60 caracteres",
"data_start": "Formato ( dd/mm/yyyy h:i )",
"data_end": "Formato ( dd/mm/yyyy h:i )",
"tipo_mensagem": "id da categoria",
"color": "hexadecimal (#000000)",
"mensagem_sms": "id mensagem sms",
"user_inc": "id usuário",
"user_upd": "id do usuário",
"_embedded": "mensagem": {
"id": interiro,
"nome": "string",
"text": "string",
"remetente": "string",
"data_inc": {
"date": "2015-02-05 16:41:47.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"user_inc": inteiro,
"data_upd": {
"date": "2019-04-17 11:55:45.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"user_upd": 1,
"_links": {
"self": {
"href": "http://api.alweb.site/template/3"
}
}
}
"_links": {
"self": {
"href": "http://api.alweb.site/agendamensagem/84"
}
}
}
]
}
}
POST /agendamensagem
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 60 caracteres |
YES |
| data_start | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| data_end | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| tipo_mensagem | inteiro | id da categoria |
YES |
| color | string | hexadecimal (#000000) |
NO |
| mensagem_sms | inteiro | id mensagem sms |
NO |
| user_inc | inteiro | id usuário |
YES |
| user_upd | inteiro | id do usuário |
YES |
| mensagem | inteiro | id do template |
YES |
| evento | text | Id do Evento |
YES |
| destino_mensagem | text | YES | |
| data_inc | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "Max. 60 caracteres",
"data_start": "Formato ( dd/mm/yyyy h:i )",
"data_end": "Formato ( dd/mm/yyyy h:i )",
"tipo_mensagem": "id da categoria",
"color": "hexadecimal (#000000)",
"mensagem_sms": "id mensagem sms",
"user_inc": "id usuário",
"user_upd": "id do usuário",
"mensagem": "textarea (template html)"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"id": id,
"nome": "nome do agendamento",
"data_start": {
"date": "2019-04-19 10:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_end": {
"date": "2019-04-19 10:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"is_tipo_mensagem": "1",
"color": "#4a38a8",
"data_inc": {
"date": "2019-04-23 13:58:47.014193",
"timezone_type": 3,
"timezone": "UTC"
},
"user_inc": "1",
"data_upd": {
"date": "2019-04-23 13:58:47.014197",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": "1",
"mensagem_sms": null,
"_embedded": {
"mensagem": {
"id": 3,
"nome": "nome do template",
"text": "Corpo da mensagem",
"remetente": "email rementente",
"data_inc": {
"date": "2015-02-05 16:41:47.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_inc": id usuário que cadastrou,
"data_upd": {
"date": "2019-04-17 11:55:45.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id usuário que editou,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/template/3"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/agendamensagem/85"
}
}
}
GET /agendamensagem[/:agenda_mensagem_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 60 caracteres |
YES |
| data_start | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| data_end | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| tipo_mensagem | inteiro | id da categoria |
YES |
| color | string | hexadecimal (#000000) |
NO |
| mensagem_sms | inteiro | id mensagem sms |
NO |
| user_inc | inteiro | id usuário |
YES |
| user_upd | inteiro | id do usuário |
YES |
| mensagem | inteiro | id do template |
YES |
| evento | text | Id do Evento |
YES |
| destino_mensagem | text | YES | |
| data_inc | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"id": 2,
"nome": "nome do agendamento",
"data_start": {
"date": "2015-09-15 15:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_end": {
"date": "2015-09-15 15:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"is_tipo_mensagem": false,
"color": "#bf264a",
"data_inc": {
"date": "2015-09-15 13:29:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_inc": usuario que cadastrou,
"data_upd": {
"date": "2015-09-15 13:29:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": usuário que editou,
"mensagem_sms": null,
"_embedded": {
"mensagem": {
"id": 2,
"nome": "Nome do template",
"text": "corpo da mensagem",
"remetente": "email rementente",
"data_inc": {
"date": "2015-09-15 13:24:44.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_inc": id do usuario que cadastrou,
"data_upd": {
"date": "2015-09-15 13:24:44.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuario que atualizou,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/template/2"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/agendamensagem/2"
}
}
}
PATCH /agendamensagem[/:agenda_mensagem_id]
Não suportado
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 60 caracteres |
YES |
| data_start | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| data_end | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| tipo_mensagem | inteiro | id da categoria |
YES |
| color | string | hexadecimal (#000000) |
NO |
| mensagem_sms | inteiro | id mensagem sms |
NO |
| user_inc | inteiro | id usuário |
YES |
| user_upd | inteiro | id do usuário |
YES |
| mensagem | inteiro | id do template |
YES |
| evento | text | Id do Evento |
YES |
| destino_mensagem | text | YES | |
| data_inc | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /agendamensagem[/:agenda_mensagem_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 60 caracteres |
YES |
| data_start | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| data_end | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| tipo_mensagem | inteiro | id da categoria |
YES |
| color | string | hexadecimal (#000000) |
NO |
| mensagem_sms | inteiro | id mensagem sms |
NO |
| user_inc | inteiro | id usuário |
YES |
| user_upd | inteiro | id do usuário |
YES |
| mensagem | inteiro | id do template |
YES |
| evento | text | Id do Evento |
YES |
| destino_mensagem | text | YES | |
| data_inc | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "Max. 60 caracteres",
"data_start": "Formato ( dd/mm/yyyy h:i )",
"data_end": "Formato ( dd/mm/yyyy h:i )",
"tipo_mensagem": "id da categoria",
"color": "hexadecimal (#000000)",
"mensagem_sms": "id mensagem sms",
"user_inc": "id usuário",
"user_upd": "id do usuário",
"mensagem": "textarea (template html)"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"id": id,
"nome": "nome do agendamento",
"data_start": {
"date": "2019-04-19 10:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_end": {
"date": "2019-04-19 10:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"is_tipo_mensagem": "1",
"color": "#4a38a8",
"data_inc": {
"date": "2019-04-23 13:58:47.014193",
"timezone_type": 3,
"timezone": "UTC"
},
"user_inc": "1",
"data_upd": {
"date": "2019-04-23 13:58:47.014197",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": "1",
"mensagem_sms": null,
"_embedded": {
"mensagem": {
"id": 3,
"nome": "nome do template",
"text": "Corpo da mensagem",
"remetente": "email rementente",
"data_inc": {
"date": "2015-02-05 16:41:47.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_inc": id usuário que cadastrou,
"data_upd": {
"date": "2019-04-17 11:55:45.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id usuário que editou,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/template/3"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/agendamensagem/85"
}
}
}
DELETE /agendamensagem[/:agenda_mensagem_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 60 caracteres |
YES |
| data_start | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| data_end | string | Formato ( dd/mm/yyyy h:i ) |
YES |
| tipo_mensagem | inteiro | id da categoria |
YES |
| color | string | hexadecimal (#000000) |
NO |
| mensagem_sms | inteiro | id mensagem sms |
NO |
| user_inc | inteiro | id usuário |
YES |
| user_upd | inteiro | id do usuário |
YES |
| mensagem | inteiro | id do template |
YES |
| evento | text | Id do Evento |
YES |
| destino_mensagem | text | YES | |
| data_inc | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
AppConfig
GET /appconfig
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| logo_evento | text | Link da image do logotipo |
NO |
| image_evento | text | Link da imagem do evento |
NO |
| image_topo_banner | text | Imagem banner topo |
NO |
| banner | textarea | Conjunto de banner |
NO |
| redes_sociais | textarea | Redes sociais do aplicativo |
NO |
| link_credenciamento | text | Link externo para o credenciamento |
NO |
| link_planta_baixa | text | Link externo para planta baixa |
NO |
| link_hospedagem | text | Link externo para hospedagem |
NO |
| evento_id | inteiro | Id do evento no aplicativo |
NO |
| bl_category_news_id | inteiro | Id das notícias que serão veiculados no aplicativo |
NO |
| banner_superior | textarea | Lista em formato JSON banner |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /appconfig
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| logo_evento | text | Link da image do logotipo |
NO |
| image_evento | text | Link da imagem do evento |
NO |
| image_topo_banner | text | Imagem banner topo |
NO |
| banner | textarea | Conjunto de banner |
NO |
| redes_sociais | textarea | Redes sociais do aplicativo |
NO |
| link_credenciamento | text | Link externo para o credenciamento |
NO |
| link_planta_baixa | text | Link externo para planta baixa |
NO |
| link_hospedagem | text | Link externo para hospedagem |
NO |
| evento_id | inteiro | Id do evento no aplicativo |
NO |
| bl_category_news_id | inteiro | Id das notícias que serão veiculados no aplicativo |
NO |
| banner_superior | textarea | Lista em formato JSON banner |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /appconfig[/:app_config_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| logo_evento | text | Link da image do logotipo |
NO |
| image_evento | text | Link da imagem do evento |
NO |
| image_topo_banner | text | Imagem banner topo |
NO |
| banner | textarea | Conjunto de banner |
NO |
| redes_sociais | textarea | Redes sociais do aplicativo |
NO |
| link_credenciamento | text | Link externo para o credenciamento |
NO |
| link_planta_baixa | text | Link externo para planta baixa |
NO |
| link_hospedagem | text | Link externo para hospedagem |
NO |
| evento_id | inteiro | Id do evento no aplicativo |
NO |
| bl_category_news_id | inteiro | Id das notícias que serão veiculados no aplicativo |
NO |
| banner_superior | textarea | Lista em formato JSON banner |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /appconfig[/:app_config_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| logo_evento | text | Link da image do logotipo |
NO |
| image_evento | text | Link da imagem do evento |
NO |
| image_topo_banner | text | Imagem banner topo |
NO |
| banner | textarea | Conjunto de banner |
NO |
| redes_sociais | textarea | Redes sociais do aplicativo |
NO |
| link_credenciamento | text | Link externo para o credenciamento |
NO |
| link_planta_baixa | text | Link externo para planta baixa |
NO |
| link_hospedagem | text | Link externo para hospedagem |
NO |
| evento_id | inteiro | Id do evento no aplicativo |
NO |
| bl_category_news_id | inteiro | Id das notícias que serão veiculados no aplicativo |
NO |
| banner_superior | textarea | Lista em formato JSON banner |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /appconfig[/:app_config_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| logo_evento | text | Link da image do logotipo |
NO |
| image_evento | text | Link da imagem do evento |
NO |
| image_topo_banner | text | Imagem banner topo |
NO |
| banner | textarea | Conjunto de banner |
NO |
| redes_sociais | textarea | Redes sociais do aplicativo |
NO |
| link_credenciamento | text | Link externo para o credenciamento |
NO |
| link_planta_baixa | text | Link externo para planta baixa |
NO |
| link_hospedagem | text | Link externo para hospedagem |
NO |
| evento_id | inteiro | Id do evento no aplicativo |
NO |
| bl_category_news_id | inteiro | Id das notícias que serão veiculados no aplicativo |
NO |
| banner_superior | textarea | Lista em formato JSON banner |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /appconfig[/:app_config_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| logo_evento | text | Link da image do logotipo |
NO |
| image_evento | text | Link da imagem do evento |
NO |
| image_topo_banner | text | Imagem banner topo |
NO |
| banner | textarea | Conjunto de banner |
NO |
| redes_sociais | textarea | Redes sociais do aplicativo |
NO |
| link_credenciamento | text | Link externo para o credenciamento |
NO |
| link_planta_baixa | text | Link externo para planta baixa |
NO |
| link_hospedagem | text | Link externo para hospedagem |
NO |
| evento_id | inteiro | Id do evento no aplicativo |
NO |
| bl_category_news_id | inteiro | Id das notícias que serão veiculados no aplicativo |
NO |
| banner_superior | textarea | Lista em formato JSON banner |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
ArquivoPedido
Arquivos enviados a promotora
GET /arquivopedido
Coleção de arquivos enviados
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max 60 caracteres |
YES |
| descricao | string | Observação sobre arquivo |
NO |
| arquivo | string | nome do arquivo |
YES |
| status | Status do arquivo |
YES | |
| user_inc | inteiro | id do usuario |
YES |
| user_upd | inteiro | id do usuario |
YES |
| tipo_arquivo_pedido | inteiro | id do tipo de arquivo |
YES |
| pedido | inteiro | id do pedido |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=1"
},
"first": {
"href": "https://apisafe.alweb.com.br/arquivopedido"
},
"last": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=137"
},
"next": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=2"
}
},
"_embedded": {
"arquivo_pedido": [
{
"id": 2,
"nome": "Nome do arquivo",
"descricao": "observação",
"arquivo": "nome_do_arquivo",
"is_status": false,
"user_inc": id do usuário que cadastrou,
"data_inc": {
"date": "2015-08-01 18:24:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que editou,
"data_upd": {
"date": "2015-08-01 18:24:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"_embedded": {
"pedido": {
"id": id do contrato,
"estande": "numero do estande",
"metragem": 156,
"rua": "4",
"corredor": "e",
"portao_carga": ".",
"observacao": "",
"status_montadora": false,
"posy": null,
"posx": null,
"user_inc": 1,
"data_inc": {
"date": "2014-08-25 19:56:44.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": 1,
"data_upd": {
"date": "2015-07-04 10:04:57.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_cad_montadora": null,
"montadora_id": null,
"planta_estande": {},
"termomontadora": {},
"pedido_kwa": {},
"_embedded": {
"pavilhao_id": {
"id": 1,
"nome": "Pavilhão 1",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/pavilhao/1"
}
}
},
"evento_id": {
"id": id do evento,
"nome": "nome do evento",
"edicao": "edição do evento",
"slug": "nome do evento tratado",
"local_evento": "Local do evento",
"data_ini": {
"date": "2014-11-17 09:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_fim": {
"date": "2014-11-19 19:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"url": "url site do evento",
"descricao": "descrição doe vento",
"imagem": "imagem do evento",
"planta": "planta do evento",
"valor_montagem": null,
"data_planta": null,
"data_montadora": null,
"data_credenciamento": null,
"cred_evento": null,
"cred_antecipado": null,
"user_inc": id do usuário que cadastrou,
"data_inc": {
"date": "2015-07-04 21:23:51.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que atualizou,
"data_upd": {
"date": "2015-07-04 21:23:51.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"mapa_level": {},
"guarda_malas": {},
"data_prazo_montagem": null,
"valor_montagem_antecipado": null,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/evento/16"
}
}
},
"cliente_id": {
"id": id do cliente,
"nome": "razão social do cliente",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": " ",
"compl": "",
"bairro": "",
"cep": "",
"cidade": "",
"estado": "",
"pais": "Brasil",
"fone1": "",
"fone2": "",
"celular": "",
"contato": "",
"cargo": "",
"image": null,
"marcas": "",
"site": "",
"is_status": true,
"status_fiscal": true,
"data_cad": {
"date": "2011-08-08 15:47:21.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_cad": id do usuário que cadastrou,
"data_upd": {
"date": "2019-04-12 16:10:12.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que editou,
"produto_cliente": {},
"regime_tributario": null,
"staff": {},
"usuarios": {},
"historico_liente": {},
"credenciamento_cliente": {},
"_embedded": {
"tipo_cliente": {
"id": 2,
"nome": "Expositor",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/tipocliente/2"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/cliente/424"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/pedido/2415"
}
}
},
"tipo_arquivo_pedido": {
"id": 1,
"nome": "Planta baixa cotada",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/tipoarquivopedido/1"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/arquivopedido/2"
}
}
},
]
},
"page_count": 137,
"page_size": 25,
"total_items": 3414,
"page": 1
}
POST /arquivopedido
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max 60 caracteres |
YES |
| descricao | string | Observação sobre arquivo |
NO |
| arquivo | string | nome do arquivo |
YES |
| status | Status do arquivo |
YES | |
| user_inc | inteiro | id do usuario |
YES |
| user_upd | inteiro | id do usuario |
YES |
| tipo_arquivo_pedido | inteiro | id do tipo de arquivo |
YES |
| pedido | inteiro | id do pedido |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "Max 60 caracteres",
"descricao": "Observação sobre arquivo",
"arquivo": "nome do arquivo",
"status": "Status do arquivo",
"user_inc": "id do usuario",
"user_upd": "id do usuario",
"tipo_arquivo_pedido": "id do tipo de arquivo",
"pedido": "id do pedido"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=1"
},
"first": {
"href": "https://apisafe.alweb.com.br/arquivopedido"
},
"last": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=137"
},
"next": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=2"
}
},
"_embedded": {
"arquivo_pedido": [
{
"id": 2,
"nome": "Nome do arquivo",
"descricao": "observação",
"arquivo": "nome_do_arquivo",
"is_status": false,
"user_inc": id do usuário que cadastrou,
"data_inc": {
"date": "2015-08-01 18:24:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que editou,
"data_upd": {
"date": "2015-08-01 18:24:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"_embedded": {
"pedido": {
"id": id do contrato,
"estande": "numero do estande",
"metragem": 156,
"rua": "4",
"corredor": "e",
"portao_carga": ".",
"observacao": "",
"status_montadora": false,
"posy": null,
"posx": null,
"user_inc": 1,
"data_inc": {
"date": "2014-08-25 19:56:44.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": 1,
"data_upd": {
"date": "2015-07-04 10:04:57.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_cad_montadora": null,
"montadora_id": null,
"planta_estande": {},
"termomontadora": {},
"pedido_kwa": {},
"_embedded": {
"pavilhao_id": {
"id": 1,
"nome": "Pavilhão 1",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/pavilhao/1"
}
}
},
"evento_id": {
"id": id do evento,
"nome": "nome do evento",
"edicao": "edição do evento",
"slug": "nome do evento tratado",
"local_evento": "Local do evento",
"data_ini": {
"date": "2014-11-17 09:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_fim": {
"date": "2014-11-19 19:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"url": "url site do evento",
"descricao": "descrição doe vento",
"imagem": "imagem do evento",
"planta": "planta do evento",
"valor_montagem": null,
"data_planta": null,
"data_montadora": null,
"data_credenciamento": null,
"cred_evento": null,
"cred_antecipado": null,
"user_inc": id do usuário que cadastrou,
"data_inc": {
"date": "2015-07-04 21:23:51.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que atualizou,
"data_upd": {
"date": "2015-07-04 21:23:51.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"mapa_level": {},
"guarda_malas": {},
"data_prazo_montagem": null,
"valor_montagem_antecipado": null,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/evento/16"
}
}
},
"cliente_id": {
"id": id do cliente,
"nome": "razão social do cliente",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": " ",
"compl": "",
"bairro": "",
"cep": "",
"cidade": "",
"estado": "",
"pais": "Brasil",
"fone1": "",
"fone2": "",
"celular": "",
"contato": "",
"cargo": "",
"image": null,
"marcas": "",
"site": "",
"is_status": true,
"status_fiscal": true,
"data_cad": {
"date": "2011-08-08 15:47:21.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_cad": id do usuário que cadastrou,
"data_upd": {
"date": "2019-04-12 16:10:12.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que editou,
"produto_cliente": {},
"regime_tributario": null,
"staff": {},
"usuarios": {},
"historico_liente": {},
"credenciamento_cliente": {},
"_embedded": {
"tipo_cliente": {
"id": 2,
"nome": "Expositor",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/tipocliente/2"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/cliente/424"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/pedido/2415"
}
}
},
"tipo_arquivo_pedido": {
"id": 1,
"nome": "Planta baixa cotada",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/tipoarquivopedido/1"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/arquivopedido/2"
}
}
},
]
},
"page_count": 137,
"page_size": 25,
"total_items": 3414,
"page": 1
}
GET /arquivopedido[/:arquivo_pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max 60 caracteres |
YES |
| descricao | string | Observação sobre arquivo |
NO |
| arquivo | string | nome do arquivo |
YES |
| status | Status do arquivo |
YES | |
| user_inc | inteiro | id do usuario |
YES |
| user_upd | inteiro | id do usuario |
YES |
| tipo_arquivo_pedido | inteiro | id do tipo de arquivo |
YES |
| pedido | inteiro | id do pedido |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=1"
},
"first": {
"href": "https://apisafe.alweb.com.br/arquivopedido"
},
"last": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=137"
},
"next": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=2"
}
},
"_embedded": {
"arquivo_pedido": [
{
"id": 2,
"nome": "Nome do arquivo",
"descricao": "observação",
"arquivo": "nome_do_arquivo",
"is_status": false,
"user_inc": id do usuário que cadastrou,
"data_inc": {
"date": "2015-08-01 18:24:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que editou,
"data_upd": {
"date": "2015-08-01 18:24:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"_embedded": {
"pedido": {
"id": id do contrato,
"estande": "numero do estande",
"metragem": 156,
"rua": "4",
"corredor": "e",
"portao_carga": ".",
"observacao": "",
"status_montadora": false,
"posy": null,
"posx": null,
"user_inc": 1,
"data_inc": {
"date": "2014-08-25 19:56:44.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": 1,
"data_upd": {
"date": "2015-07-04 10:04:57.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_cad_montadora": null,
"montadora_id": null,
"planta_estande": {},
"termomontadora": {},
"pedido_kwa": {},
"_embedded": {
"pavilhao_id": {
"id": 1,
"nome": "Pavilhão 1",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/pavilhao/1"
}
}
},
"evento_id": {
"id": id do evento,
"nome": "nome do evento",
"edicao": "edição do evento",
"slug": "nome do evento tratado",
"local_evento": "Local do evento",
"data_ini": {
"date": "2014-11-17 09:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_fim": {
"date": "2014-11-19 19:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"url": "url site do evento",
"descricao": "descrição doe vento",
"imagem": "imagem do evento",
"planta": "planta do evento",
"valor_montagem": null,
"data_planta": null,
"data_montadora": null,
"data_credenciamento": null,
"cred_evento": null,
"cred_antecipado": null,
"user_inc": id do usuário que cadastrou,
"data_inc": {
"date": "2015-07-04 21:23:51.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que atualizou,
"data_upd": {
"date": "2015-07-04 21:23:51.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"mapa_level": {},
"guarda_malas": {},
"data_prazo_montagem": null,
"valor_montagem_antecipado": null,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/evento/16"
}
}
},
"cliente_id": {
"id": id do cliente,
"nome": "razão social do cliente",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": " ",
"compl": "",
"bairro": "",
"cep": "",
"cidade": "",
"estado": "",
"pais": "Brasil",
"fone1": "",
"fone2": "",
"celular": "",
"contato": "",
"cargo": "",
"image": null,
"marcas": "",
"site": "",
"is_status": true,
"status_fiscal": true,
"data_cad": {
"date": "2011-08-08 15:47:21.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_cad": id do usuário que cadastrou,
"data_upd": {
"date": "2019-04-12 16:10:12.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que editou,
"produto_cliente": {},
"regime_tributario": null,
"staff": {},
"usuarios": {},
"historico_liente": {},
"credenciamento_cliente": {},
"_embedded": {
"tipo_cliente": {
"id": 2,
"nome": "Expositor",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/tipocliente/2"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/cliente/424"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/pedido/2415"
}
}
},
"tipo_arquivo_pedido": {
"id": 1,
"nome": "Planta baixa cotada",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/tipoarquivopedido/1"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/arquivopedido/2"
}
}
},
]
},
"page_count": 137,
"page_size": 25,
"total_items": 3414,
"page": 1
}
PATCH /arquivopedido[/:arquivo_pedido_id]
Não disponível
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max 60 caracteres |
YES |
| descricao | string | Observação sobre arquivo |
NO |
| arquivo | string | nome do arquivo |
YES |
| status | Status do arquivo |
YES | |
| user_inc | inteiro | id do usuario |
YES |
| user_upd | inteiro | id do usuario |
YES |
| tipo_arquivo_pedido | inteiro | id do tipo de arquivo |
YES |
| pedido | inteiro | id do pedido |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /arquivopedido[/:arquivo_pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max 60 caracteres |
YES |
| descricao | string | Observação sobre arquivo |
NO |
| arquivo | string | nome do arquivo |
YES |
| status | Status do arquivo |
YES | |
| user_inc | inteiro | id do usuario |
YES |
| user_upd | inteiro | id do usuario |
YES |
| tipo_arquivo_pedido | inteiro | id do tipo de arquivo |
YES |
| pedido | inteiro | id do pedido |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "Max 60 caracteres",
"descricao": "Observação sobre arquivo",
"arquivo": "nome do arquivo",
"status": "Status do arquivo",
"user_inc": "id do usuario",
"user_upd": "id do usuario",
"tipo_arquivo_pedido": "id do tipo de arquivo",
"pedido": "id do pedido"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=1"
},
"first": {
"href": "https://apisafe.alweb.com.br/arquivopedido"
},
"last": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=137"
},
"next": {
"href": "https://apisafe.alweb.com.br/arquivopedido?page=2"
}
},
"_embedded": {
"arquivo_pedido": [
{
"id": 2,
"nome": "Nome do arquivo",
"descricao": "observação",
"arquivo": "nome_do_arquivo",
"is_status": false,
"user_inc": id do usuário que cadastrou,
"data_inc": {
"date": "2015-08-01 18:24:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que editou,
"data_upd": {
"date": "2015-08-01 18:24:07.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"_embedded": {
"pedido": {
"id": id do contrato,
"estande": "numero do estande",
"metragem": 156,
"rua": "4",
"corredor": "e",
"portao_carga": ".",
"observacao": "",
"status_montadora": false,
"posy": null,
"posx": null,
"user_inc": 1,
"data_inc": {
"date": "2014-08-25 19:56:44.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": 1,
"data_upd": {
"date": "2015-07-04 10:04:57.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_cad_montadora": null,
"montadora_id": null,
"planta_estande": {},
"termomontadora": {},
"pedido_kwa": {},
"_embedded": {
"pavilhao_id": {
"id": 1,
"nome": "Pavilhão 1",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/pavilhao/1"
}
}
},
"evento_id": {
"id": id do evento,
"nome": "nome do evento",
"edicao": "edição do evento",
"slug": "nome do evento tratado",
"local_evento": "Local do evento",
"data_ini": {
"date": "2014-11-17 09:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"data_fim": {
"date": "2014-11-19 19:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"url": "url site do evento",
"descricao": "descrição doe vento",
"imagem": "imagem do evento",
"planta": "planta do evento",
"valor_montagem": null,
"data_planta": null,
"data_montadora": null,
"data_credenciamento": null,
"cred_evento": null,
"cred_antecipado": null,
"user_inc": id do usuário que cadastrou,
"data_inc": {
"date": "2015-07-04 21:23:51.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que atualizou,
"data_upd": {
"date": "2015-07-04 21:23:51.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"mapa_level": {},
"guarda_malas": {},
"data_prazo_montagem": null,
"valor_montagem_antecipado": null,
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/evento/16"
}
}
},
"cliente_id": {
"id": id do cliente,
"nome": "razão social do cliente",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": " ",
"compl": "",
"bairro": "",
"cep": "",
"cidade": "",
"estado": "",
"pais": "Brasil",
"fone1": "",
"fone2": "",
"celular": "",
"contato": "",
"cargo": "",
"image": null,
"marcas": "",
"site": "",
"is_status": true,
"status_fiscal": true,
"data_cad": {
"date": "2011-08-08 15:47:21.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_cad": id do usuário que cadastrou,
"data_upd": {
"date": "2019-04-12 16:10:12.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"user_upd": id do usuário que editou,
"produto_cliente": {},
"regime_tributario": null,
"staff": {},
"usuarios": {},
"historico_liente": {},
"credenciamento_cliente": {},
"_embedded": {
"tipo_cliente": {
"id": 2,
"nome": "Expositor",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/tipocliente/2"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/cliente/424"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/pedido/2415"
}
}
},
"tipo_arquivo_pedido": {
"id": 1,
"nome": "Planta baixa cotada",
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/tipoarquivopedido/1"
}
}
}
},
"_links": {
"self": {
"href": "https://apisafe.alweb.com.br/arquivopedido/2"
}
}
},
]
},
"page_count": 137,
"page_size": 25,
"total_items": 3414,
"page": 1
}
DELETE /arquivopedido[/:arquivo_pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max 60 caracteres |
YES |
| descricao | string | Observação sobre arquivo |
NO |
| arquivo | string | nome do arquivo |
YES |
| status | Status do arquivo |
YES | |
| user_inc | inteiro | id do usuario |
YES |
| user_upd | inteiro | id do usuario |
YES |
| tipo_arquivo_pedido | inteiro | id do tipo de arquivo |
YES |
| pedido | inteiro | id do pedido |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Auth
GET /auth
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| text | Login |
YES | |
| senha | password | Campo de senha |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /auth
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| text | Login |
YES | |
| senha | password | Campo de senha |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /auth[/:auth_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| text | Login |
YES | |
| senha | password | Campo de senha |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /auth[/:auth_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| text | Login |
YES | |
| senha | password | Campo de senha |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /auth[/:auth_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| text | Login |
YES | |
| senha | password | Campo de senha |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /auth[/:auth_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| text | Login |
YES | |
| senha | password | Campo de senha |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
BlCategoryNews
GET /categorynews
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Campo de nome da categoria |
YES |
| slug | text | Slug da categoria |
NO |
| label | text | Label da categoria |
NO |
| description | textarea | Descrição da categoria |
NO |
| color | text | Cor da categoria |
NO |
| classes | text | Classes css da categoria |
NO |
| keywords | textarea | Palavras chaves meta |
NO |
| category_id | text | Categoria pai |
NO |
| layout | string | nome do layout da categoria |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /categorynews
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Campo de nome da categoria |
YES |
| slug | text | Slug da categoria |
NO |
| label | text | Label da categoria |
NO |
| description | textarea | Descrição da categoria |
NO |
| color | text | Cor da categoria |
NO |
| classes | text | Classes css da categoria |
NO |
| keywords | textarea | Palavras chaves meta |
NO |
| category_id | text | Categoria pai |
NO |
| layout | string | nome do layout da categoria |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /categorynews[/:bl_category_news_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Campo de nome da categoria |
YES |
| slug | text | Slug da categoria |
NO |
| label | text | Label da categoria |
NO |
| description | textarea | Descrição da categoria |
NO |
| color | text | Cor da categoria |
NO |
| classes | text | Classes css da categoria |
NO |
| keywords | textarea | Palavras chaves meta |
NO |
| category_id | text | Categoria pai |
NO |
| layout | string | nome do layout da categoria |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /categorynews[/:bl_category_news_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Campo de nome da categoria |
YES |
| slug | text | Slug da categoria |
NO |
| label | text | Label da categoria |
NO |
| description | textarea | Descrição da categoria |
NO |
| color | text | Cor da categoria |
NO |
| classes | text | Classes css da categoria |
NO |
| keywords | textarea | Palavras chaves meta |
NO |
| category_id | text | Categoria pai |
NO |
| layout | string | nome do layout da categoria |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /categorynews[/:bl_category_news_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Campo de nome da categoria |
YES |
| slug | text | Slug da categoria |
NO |
| label | text | Label da categoria |
NO |
| description | textarea | Descrição da categoria |
NO |
| color | text | Cor da categoria |
NO |
| classes | text | Classes css da categoria |
NO |
| keywords | textarea | Palavras chaves meta |
NO |
| category_id | text | Categoria pai |
NO |
| layout | string | nome do layout da categoria |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /categorynews[/:bl_category_news_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Campo de nome da categoria |
YES |
| slug | text | Slug da categoria |
NO |
| label | text | Label da categoria |
NO |
| description | textarea | Descrição da categoria |
NO |
| color | text | Cor da categoria |
NO |
| classes | text | Classes css da categoria |
NO |
| keywords | textarea | Palavras chaves meta |
NO |
| category_id | text | Categoria pai |
NO |
| layout | string | nome do layout da categoria |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
BlGallery
GET /gallery
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Nome da galeria |
YES |
| description | string | Meta description |
YES |
| keyword | string | Palavras chaves |
NO |
| slug | string | Slug |
NO |
| status | bolean | Status de postagem |
YES |
| user_inc | Id do usuário do cadastro |
YES | |
| date_inc | Data do cadastro |
YES | |
| user_upd | Id do usuário da atualização |
YES | |
| date_upd | Data da atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /gallery
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Nome da galeria |
YES |
| description | string | Meta description |
YES |
| keyword | string | Palavras chaves |
NO |
| slug | string | Slug |
NO |
| status | bolean | Status de postagem |
YES |
| user_inc | Id do usuário do cadastro |
YES | |
| date_inc | Data do cadastro |
YES | |
| user_upd | Id do usuário da atualização |
YES | |
| date_upd | Data da atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /gallery[/:bl_gallery_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Nome da galeria |
YES |
| description | string | Meta description |
YES |
| keyword | string | Palavras chaves |
NO |
| slug | string | Slug |
NO |
| status | bolean | Status de postagem |
YES |
| user_inc | Id do usuário do cadastro |
YES | |
| date_inc | Data do cadastro |
YES | |
| user_upd | Id do usuário da atualização |
YES | |
| date_upd | Data da atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /gallery[/:bl_gallery_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Nome da galeria |
YES |
| description | string | Meta description |
YES |
| keyword | string | Palavras chaves |
NO |
| slug | string | Slug |
NO |
| status | bolean | Status de postagem |
YES |
| user_inc | Id do usuário do cadastro |
YES | |
| date_inc | Data do cadastro |
YES | |
| user_upd | Id do usuário da atualização |
YES | |
| date_upd | Data da atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /gallery[/:bl_gallery_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Nome da galeria |
YES |
| description | string | Meta description |
YES |
| keyword | string | Palavras chaves |
NO |
| slug | string | Slug |
NO |
| status | bolean | Status de postagem |
YES |
| user_inc | Id do usuário do cadastro |
YES | |
| date_inc | Data do cadastro |
YES | |
| user_upd | Id do usuário da atualização |
YES | |
| date_upd | Data da atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /gallery[/:bl_gallery_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | string | Nome da galeria |
YES |
| description | string | Meta description |
YES |
| keyword | string | Palavras chaves |
NO |
| slug | string | Slug |
NO |
| status | bolean | Status de postagem |
YES |
| user_inc | Id do usuário do cadastro |
YES | |
| date_inc | Data do cadastro |
YES | |
| user_upd | Id do usuário da atualização |
YES | |
| date_upd | Data da atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
BlImageGallery
GET /blimagegallery
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título imagem |
NO |
| alt_text_description | string | Texto alternativo |
NO |
| label_text | string | Legenda |
NO |
| label_description | string | Descrição |
NO |
| file | string | Nome do arquivo |
YES |
| order_image | inteiro | Ordem da image |
NO |
| user_inc | inteiro | Id do usuário |
YES |
| date_inc | YES | ||
| user_upd | Id do Usuário |
YES | |
| date_upd | YES | ||
| bl_gallery_id | Id da galeria da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/bl-image-gallery"
},
"first": {
"href": "/bl-image-gallery?page={page}"
},
"prev": {
"href": "/bl-image-gallery?page={page}"
},
"next": {
"href": "/bl-image-gallery?page={page}"
},
"last": {
"href": "/bl-image-gallery?page={page}"
}
}
"_embedded": {
"bl_image_gallery": [
{
"_links": {
"self": {
"href": "/bl-image-gallery[/:bl_image_gallery_id]"
}
}
"title": "Título da image",
"alt_text_description": "Texto alternativo",
"label_text": "Legenda",
"label_description": "Descrição",
"file": "Arquivo"
}
]
}
}
POST /blimagegallery
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título imagem |
NO |
| alt_text_description | string | Texto alternativo |
NO |
| label_text | string | Legenda |
NO |
| label_description | string | Descrição |
NO |
| file | string | Nome do arquivo |
YES |
| order_image | inteiro | Ordem da image |
NO |
| user_inc | inteiro | Id do usuário |
YES |
| date_inc | YES | ||
| user_upd | Id do Usuário |
YES | |
| date_upd | YES | ||
| bl_gallery_id | Id da galeria da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"title": "Título da image",
"alt_text_description": "Texto alternativo",
"label_text": "Legenda",
"label_description": "Descrição",
"file": "Arquivo"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/bl-image-gallery[/:bl_image_gallery_id]"
}
}
"title": "Título da image",
"alt_text_description": "Texto alternativo",
"label_text": "Legenda",
"label_description": "Descrição",
"file": "Arquivo"
}
GET /blimagegallery[/:bl_image_gallery_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título imagem |
NO |
| alt_text_description | string | Texto alternativo |
NO |
| label_text | string | Legenda |
NO |
| label_description | string | Descrição |
NO |
| file | string | Nome do arquivo |
YES |
| order_image | inteiro | Ordem da image |
NO |
| user_inc | inteiro | Id do usuário |
YES |
| date_inc | YES | ||
| user_upd | Id do Usuário |
YES | |
| date_upd | YES | ||
| bl_gallery_id | Id da galeria da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /blimagegallery[/:bl_image_gallery_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título imagem |
NO |
| alt_text_description | string | Texto alternativo |
NO |
| label_text | string | Legenda |
NO |
| label_description | string | Descrição |
NO |
| file | string | Nome do arquivo |
YES |
| order_image | inteiro | Ordem da image |
NO |
| user_inc | inteiro | Id do usuário |
YES |
| date_inc | YES | ||
| user_upd | Id do Usuário |
YES | |
| date_upd | YES | ||
| bl_gallery_id | Id da galeria da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /blimagegallery[/:bl_image_gallery_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título imagem |
NO |
| alt_text_description | string | Texto alternativo |
NO |
| label_text | string | Legenda |
NO |
| label_description | string | Descrição |
NO |
| file | string | Nome do arquivo |
YES |
| order_image | inteiro | Ordem da image |
NO |
| user_inc | inteiro | Id do usuário |
YES |
| date_inc | YES | ||
| user_upd | Id do Usuário |
YES | |
| date_upd | YES | ||
| bl_gallery_id | Id da galeria da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /blimagegallery[/:bl_image_gallery_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título imagem |
NO |
| alt_text_description | string | Texto alternativo |
NO |
| label_text | string | Legenda |
NO |
| label_description | string | Descrição |
NO |
| file | string | Nome do arquivo |
YES |
| order_image | inteiro | Ordem da image |
NO |
| user_inc | inteiro | Id do usuário |
YES |
| date_inc | YES | ||
| user_upd | Id do Usuário |
YES | |
| date_upd | YES | ||
| bl_gallery_id | Id da galeria da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
BlNews
GET /blnews[/:bl_news_id[/:slug]]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título da notícia |
YES |
| description | string | Descrição da notícia |
YES |
| content | string | Conteúdo da página |
YES |
| slug | string | Slug da página |
NO |
| keyword | string | Palavras-chave |
NO |
| status | inteiro | Status de publicação |
YES |
| image | string | Imagem de destaque |
NO |
| video | string | Embedded vídeo |
NO |
| views | inteiro | Número de visualizações |
NO |
| layout | string | Layout da página |
NO |
| tipo | inteiro | Tipo de postagem |
YES |
| user_inc | Id do usuário cadastrante |
YES | |
| date_inc | datetime | Data do cadastro |
YES |
| user_upd | inteiro | Id do usuário da atualização |
YES |
| data_upd | datetime | Data da atualização |
YES |
| bl_gallery_id | inteiro | Id da galeria anexada |
NO |
| bl_category_news | array | Categorias do post |
NO |
| user_pub | string | Autor do post |
YES |
| title_es | string | Título espanhol |
NO |
| title_en | string | Título em inglês |
NO |
| description_es | Descrição em espanhol |
NO | |
| description_en | Descrição inglês |
NO | |
| content_es | Conteúdo em espanhol |
NO | |
| content_en | string | Conteúdo em inglês |
NO |
| data_pub | datetime | Data da publicação |
YES |
| image_description | string | Descrição da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/blnews"
},
"first": {
"href": "/blnews?page={page}"
},
"prev": {
"href": "/blnews?page={page}"
},
"next": {
"href": "/blnews?page={page}"
},
"last": {
"href": "/blnews?page={page}"
}
}
"_embedded": {
"bl_news": [
{
"_links": {
"self": {
"href": "/blnews[/:bl_news_id]"
}
}
"title": "Título da notícia",
"description": "Descrição da notícia",
"content": "Conteúdo da página",
"slug": "Slug da página",
"keyword": "Palavras-chave",
"status": "Status de publicação",
"image": "Imagem de destaque",
"video": "Embedded vídeo",
"data_pub": "Data da publicação",
"views": "Número de visualizações",
"layout": "Layout da página",
"tipo": "Tipo de postagem",
"user_inc": "Id do usuário cadastrante",
"date_inc": "Data do cadastro",
"user_upd": "Id do usuário da atualização",
"data_upd": "Data da atualização",
"bl_gallery_id": "Id da galeria anexada"
}
]
}
}
POST /blnews[/:bl_news_id[/:slug]]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título da notícia |
YES |
| description | string | Descrição da notícia |
YES |
| content | string | Conteúdo da página |
YES |
| slug | string | Slug da página |
NO |
| keyword | string | Palavras-chave |
NO |
| status | inteiro | Status de publicação |
YES |
| image | string | Imagem de destaque |
NO |
| video | string | Embedded vídeo |
NO |
| views | inteiro | Número de visualizações |
NO |
| layout | string | Layout da página |
NO |
| tipo | inteiro | Tipo de postagem |
YES |
| user_inc | Id do usuário cadastrante |
YES | |
| date_inc | datetime | Data do cadastro |
YES |
| user_upd | inteiro | Id do usuário da atualização |
YES |
| data_upd | datetime | Data da atualização |
YES |
| bl_gallery_id | inteiro | Id da galeria anexada |
NO |
| bl_category_news | array | Categorias do post |
NO |
| user_pub | string | Autor do post |
YES |
| title_es | string | Título espanhol |
NO |
| title_en | string | Título em inglês |
NO |
| description_es | Descrição em espanhol |
NO | |
| description_en | Descrição inglês |
NO | |
| content_es | Conteúdo em espanhol |
NO | |
| content_en | string | Conteúdo em inglês |
NO |
| data_pub | datetime | Data da publicação |
YES |
| image_description | string | Descrição da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"title": "Título da notícia",
"description": "Descrição da notícia",
"content": "Conteúdo da página",
"slug": "Slug da página",
"keyword": "Palavras-chave",
"status": "Status de publicação",
"image": "Imagem de destaque",
"video": "Embedded vídeo",
"data_pub": "Data da publicação",
"views": "Número de visualizações",
"layout": "Layout da página",
"tipo": "Tipo de postagem",
"user_inc": "Id do usuário cadastrante",
"date_inc": "Data do cadastro",
"user_upd": "Id do usuário da atualização",
"data_upd": "Data da atualização",
"bl_gallery_id": "Id da galeria anexada"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/blnews[/:bl_news_id]"
}
}
"title": "Título da notícia",
"description": "Descrição da notícia",
"content": "Conteúdo da página",
"slug": "Slug da página",
"keyword": "Palavras-chave",
"status": "Status de publicação",
"image": "Imagem de destaque",
"video": "Embedded vídeo",
"data_pub": "Data da publicação",
"views": "Número de visualizações",
"layout": "Layout da página",
"tipo": "Tipo de postagem",
"user_inc": "Id do usuário cadastrante",
"date_inc": "Data do cadastro",
"user_upd": "Id do usuário da atualização",
"data_upd": "Data da atualização",
"bl_gallery_id": "Id da galeria anexada"
}
GET /blnews[/:bl_news_id[/:slug]]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título da notícia |
YES |
| description | string | Descrição da notícia |
YES |
| content | string | Conteúdo da página |
YES |
| slug | string | Slug da página |
NO |
| keyword | string | Palavras-chave |
NO |
| status | inteiro | Status de publicação |
YES |
| image | string | Imagem de destaque |
NO |
| video | string | Embedded vídeo |
NO |
| views | inteiro | Número de visualizações |
NO |
| layout | string | Layout da página |
NO |
| tipo | inteiro | Tipo de postagem |
YES |
| user_inc | Id do usuário cadastrante |
YES | |
| date_inc | datetime | Data do cadastro |
YES |
| user_upd | inteiro | Id do usuário da atualização |
YES |
| data_upd | datetime | Data da atualização |
YES |
| bl_gallery_id | inteiro | Id da galeria anexada |
NO |
| bl_category_news | array | Categorias do post |
NO |
| user_pub | string | Autor do post |
YES |
| title_es | string | Título espanhol |
NO |
| title_en | string | Título em inglês |
NO |
| description_es | Descrição em espanhol |
NO | |
| description_en | Descrição inglês |
NO | |
| content_es | Conteúdo em espanhol |
NO | |
| content_en | string | Conteúdo em inglês |
NO |
| data_pub | datetime | Data da publicação |
YES |
| image_description | string | Descrição da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /blnews[/:bl_news_id[/:slug]]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título da notícia |
YES |
| description | string | Descrição da notícia |
YES |
| content | string | Conteúdo da página |
YES |
| slug | string | Slug da página |
NO |
| keyword | string | Palavras-chave |
NO |
| status | inteiro | Status de publicação |
YES |
| image | string | Imagem de destaque |
NO |
| video | string | Embedded vídeo |
NO |
| views | inteiro | Número de visualizações |
NO |
| layout | string | Layout da página |
NO |
| tipo | inteiro | Tipo de postagem |
YES |
| user_inc | Id do usuário cadastrante |
YES | |
| date_inc | datetime | Data do cadastro |
YES |
| user_upd | inteiro | Id do usuário da atualização |
YES |
| data_upd | datetime | Data da atualização |
YES |
| bl_gallery_id | inteiro | Id da galeria anexada |
NO |
| bl_category_news | array | Categorias do post |
NO |
| user_pub | string | Autor do post |
YES |
| title_es | string | Título espanhol |
NO |
| title_en | string | Título em inglês |
NO |
| description_es | Descrição em espanhol |
NO | |
| description_en | Descrição inglês |
NO | |
| content_es | Conteúdo em espanhol |
NO | |
| content_en | string | Conteúdo em inglês |
NO |
| data_pub | datetime | Data da publicação |
YES |
| image_description | string | Descrição da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /blnews[/:bl_news_id[/:slug]]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título da notícia |
YES |
| description | string | Descrição da notícia |
YES |
| content | string | Conteúdo da página |
YES |
| slug | string | Slug da página |
NO |
| keyword | string | Palavras-chave |
NO |
| status | inteiro | Status de publicação |
YES |
| image | string | Imagem de destaque |
NO |
| video | string | Embedded vídeo |
NO |
| views | inteiro | Número de visualizações |
NO |
| layout | string | Layout da página |
NO |
| tipo | inteiro | Tipo de postagem |
YES |
| user_inc | Id do usuário cadastrante |
YES | |
| date_inc | datetime | Data do cadastro |
YES |
| user_upd | inteiro | Id do usuário da atualização |
YES |
| data_upd | datetime | Data da atualização |
YES |
| bl_gallery_id | inteiro | Id da galeria anexada |
NO |
| bl_category_news | array | Categorias do post |
NO |
| user_pub | string | Autor do post |
YES |
| title_es | string | Título espanhol |
NO |
| title_en | string | Título em inglês |
NO |
| description_es | Descrição em espanhol |
NO | |
| description_en | Descrição inglês |
NO | |
| content_es | Conteúdo em espanhol |
NO | |
| content_en | string | Conteúdo em inglês |
NO |
| data_pub | datetime | Data da publicação |
YES |
| image_description | string | Descrição da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /blnews[/:bl_news_id[/:slug]]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| title | string | Título da notícia |
YES |
| description | string | Descrição da notícia |
YES |
| content | string | Conteúdo da página |
YES |
| slug | string | Slug da página |
NO |
| keyword | string | Palavras-chave |
NO |
| status | inteiro | Status de publicação |
YES |
| image | string | Imagem de destaque |
NO |
| video | string | Embedded vídeo |
NO |
| views | inteiro | Número de visualizações |
NO |
| layout | string | Layout da página |
NO |
| tipo | inteiro | Tipo de postagem |
YES |
| user_inc | Id do usuário cadastrante |
YES | |
| date_inc | datetime | Data do cadastro |
YES |
| user_upd | inteiro | Id do usuário da atualização |
YES |
| data_upd | datetime | Data da atualização |
YES |
| bl_gallery_id | inteiro | Id da galeria anexada |
NO |
| bl_category_news | array | Categorias do post |
NO |
| user_pub | string | Autor do post |
YES |
| title_es | string | Título espanhol |
NO |
| title_en | string | Título em inglês |
NO |
| description_es | Descrição em espanhol |
NO | |
| description_en | Descrição inglês |
NO | |
| content_es | Conteúdo em espanhol |
NO | |
| content_en | string | Conteúdo em inglês |
NO |
| data_pub | datetime | Data da publicação |
YES |
| image_description | string | Descrição da imagem |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
CategoriaEvento
GET /categoriaevento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /categoriaevento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /categoriaevento[/:categoria_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /categoriaevento[/:categoria_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /categoriaevento[/:categoria_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /categoriaevento[/:categoria_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
CategoriaReceptivo
GET /categoriareceptivo
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /categoriareceptivo
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /categoriareceptivo[/:categoria_receptivo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /categoriareceptivo[/:categoria_receptivo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /categoriareceptivo[/:categoria_receptivo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /categoriareceptivo[/:categoria_receptivo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
CategoriaStaff
Categoria Staff
GET /categoriastaff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 45 caracteres |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/categoriastaff"
},
"first": {
"href": "/categoriastaff?page={page}"
},
"prev": {
"href": "/categoriastaff?page={page}"
},
"next": {
"href": "/categoriastaff?page={page}"
},
"last": {
"href": "/categoriastaff?page={page}"
}
}
"_embedded": {
"categoria_staff": [
{
"_links": {
"self": {
"href": "/categoriastaff[/:categoria_staff_id]"
}
}
"nome": ""
}
]
}
}
POST /categoriastaff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 45 caracteres |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/categoriastaff[/:categoria_staff_id]"
}
}
"nome": ""
}
GET /categoriastaff[/:categoria_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 45 caracteres |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/categoriastaff[/:categoria_staff_id]"
}
}
"nome": ""
}
PATCH /categoriastaff[/:categoria_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 45 caracteres |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /categoriastaff[/:categoria_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 45 caracteres |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/categoriastaff[/:categoria_staff_id]"
}
}
"nome": ""
}
DELETE /categoriastaff[/:categoria_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Max. 45 caracteres |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
CidadeReceptivo
GET /cidadereceptivo
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /cidadereceptivo
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /cidadereceptivo[/:cidade_receptivo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /cidadereceptivo[/:cidade_receptivo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /cidadereceptivo[/:cidade_receptivo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /cidadereceptivo[/:cidade_receptivo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
ClientePedidoEvento
GET /clientepedidoevento
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /clientepedidoevento
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /clientepedidoevento[/:cliente_pedido_evento_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /clientepedidoevento[/:cliente_pedido_evento_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /clientepedidoevento[/:cliente_pedido_evento_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /clientepedidoevento[/:cliente_pedido_evento_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Cliente
Clientes
GET /cliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Razão social Máximo de 128 caracteres |
YES |
| logradouro | string | Nome da rua Máximo 128 caracteres |
YES |
| numero | string | Número Máximo 10 caracteres |
YES |
| bairro | string | Bairro Máximo 128 caracteres |
YES |
| cidade | string | Máximo 64 caracteres |
YES |
| estado | string | UF |
YES |
| fone1 | YES | ||
| status | YES | ||
| data_cad | YES | ||
| user_cad | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| tipo_cliente | YES | ||
| inscricao | string | Inscrição Máximo 128 caracteres |
NO |
| compl | string | Complemento do endereço Máximo 128 caracteres |
NO |
| cep | string | Máximo 9 caracteres Formato: 99999-999 |
NO |
| cnpj | text | YES | |
| site | NO | ||
| marcas | text | YES | |
| status_fiscal | text | YES | |
| celular | text | YES | |
| pais | text | NO | |
| regime_tributario | text | YES | |
| fone2 | text | NO | |
| contato | text | NO | |
| cargo | text | NO | |
| imagem | NO | ||
| produto_cliente | YES | ||
| date_foundation | string | Data de Fundação Máximo de 10 caracteres |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/cliente"
},
"first": {
"href": "/cliente?page={page}"
},
"prev": {
"href": "/cliente?page={page}"
},
"next": {
"href": "/cliente?page={page}"
},
"last": {
"href": "/cliente?page={page}"
}
}
"_embedded": {
"cliente": [
{
"_links": {
"self": {
"href": "/cliente[/:cliente_id]"
}
}
"nome": "",
"cnpj": "",
"logradouro": "",
"numero": "",
"bairro": "",
"cidade": "",
"estado": "",
"fone1": "",
"status": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"tipo_cliente_id": ""
}
]
}
}
POST /cliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Razão social Máximo de 128 caracteres |
YES |
| logradouro | string | Nome da rua Máximo 128 caracteres |
YES |
| numero | string | Número Máximo 10 caracteres |
YES |
| bairro | string | Bairro Máximo 128 caracteres |
YES |
| cidade | string | Máximo 64 caracteres |
YES |
| estado | string | UF |
YES |
| fone1 | YES | ||
| status | YES | ||
| data_cad | YES | ||
| user_cad | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| tipo_cliente | YES | ||
| inscricao | string | Inscrição Máximo 128 caracteres |
NO |
| compl | string | Complemento do endereço Máximo 128 caracteres |
NO |
| cep | string | Máximo 9 caracteres Formato: 99999-999 |
NO |
| cnpj | text | YES | |
| site | NO | ||
| marcas | text | YES | |
| status_fiscal | text | YES | |
| celular | text | YES | |
| pais | text | NO | |
| regime_tributario | text | YES | |
| fone2 | text | NO | |
| contato | text | NO | |
| cargo | text | NO | |
| imagem | NO | ||
| produto_cliente | YES | ||
| date_foundation | string | Data de Fundação Máximo de 10 caracteres |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json
multipart/form-data |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"cnpj": "",
"logradouro": "",
"numero": "",
"bairro": "",
"cidade": "",
"estado": "",
"fone1": "",
"status": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"tipo_cliente_id": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/cliente[/:cliente_id]"
}
}
"nome": "",
"cnpj": "",
"logradouro": "",
"numero": "",
"bairro": "",
"cidade": "",
"estado": "",
"fone1": "",
"status": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"tipo_cliente_id": ""
}
GET /cliente[/:cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Razão social Máximo de 128 caracteres |
YES |
| logradouro | string | Nome da rua Máximo 128 caracteres |
YES |
| numero | string | Número Máximo 10 caracteres |
YES |
| bairro | string | Bairro Máximo 128 caracteres |
YES |
| cidade | string | Máximo 64 caracteres |
YES |
| estado | string | UF |
YES |
| fone1 | YES | ||
| status | YES | ||
| data_cad | YES | ||
| user_cad | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| tipo_cliente | YES | ||
| inscricao | string | Inscrição Máximo 128 caracteres |
NO |
| compl | string | Complemento do endereço Máximo 128 caracteres |
NO |
| cep | string | Máximo 9 caracteres Formato: 99999-999 |
NO |
| cnpj | text | YES | |
| site | NO | ||
| marcas | text | YES | |
| status_fiscal | text | YES | |
| celular | text | YES | |
| pais | text | NO | |
| regime_tributario | text | YES | |
| fone2 | text | NO | |
| contato | text | NO | |
| cargo | text | NO | |
| imagem | NO | ||
| produto_cliente | YES | ||
| date_foundation | string | Data de Fundação Máximo de 10 caracteres |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/cliente[/:cliente_id]"
}
}
"nome": "",
"cnpj": "",
"logradouro": "",
"numero": "",
"bairro": "",
"cidade": "",
"estado": "",
"fone1": "",
"status": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"tipo_cliente_id": ""
}
PATCH /cliente[/:cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Razão social Máximo de 128 caracteres |
YES |
| logradouro | string | Nome da rua Máximo 128 caracteres |
YES |
| numero | string | Número Máximo 10 caracteres |
YES |
| bairro | string | Bairro Máximo 128 caracteres |
YES |
| cidade | string | Máximo 64 caracteres |
YES |
| estado | string | UF |
YES |
| fone1 | YES | ||
| status | YES | ||
| data_cad | YES | ||
| user_cad | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| tipo_cliente | YES | ||
| inscricao | string | Inscrição Máximo 128 caracteres |
NO |
| compl | string | Complemento do endereço Máximo 128 caracteres |
NO |
| cep | string | Máximo 9 caracteres Formato: 99999-999 |
NO |
| cnpj | text | YES | |
| site | NO | ||
| marcas | text | YES | |
| status_fiscal | text | YES | |
| celular | text | YES | |
| pais | text | NO | |
| regime_tributario | text | YES | |
| fone2 | text | NO | |
| contato | text | NO | |
| cargo | text | NO | |
| imagem | NO | ||
| produto_cliente | YES | ||
| date_foundation | string | Data de Fundação Máximo de 10 caracteres |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json
multipart/form-data |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /cliente[/:cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Razão social Máximo de 128 caracteres |
YES |
| logradouro | string | Nome da rua Máximo 128 caracteres |
YES |
| numero | string | Número Máximo 10 caracteres |
YES |
| bairro | string | Bairro Máximo 128 caracteres |
YES |
| cidade | string | Máximo 64 caracteres |
YES |
| estado | string | UF |
YES |
| fone1 | YES | ||
| status | YES | ||
| data_cad | YES | ||
| user_cad | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| tipo_cliente | YES | ||
| inscricao | string | Inscrição Máximo 128 caracteres |
NO |
| compl | string | Complemento do endereço Máximo 128 caracteres |
NO |
| cep | string | Máximo 9 caracteres Formato: 99999-999 |
NO |
| cnpj | text | YES | |
| site | NO | ||
| marcas | text | YES | |
| status_fiscal | text | YES | |
| celular | text | YES | |
| pais | text | NO | |
| regime_tributario | text | YES | |
| fone2 | text | NO | |
| contato | text | NO | |
| cargo | text | NO | |
| imagem | NO | ||
| produto_cliente | YES | ||
| date_foundation | string | Data de Fundação Máximo de 10 caracteres |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json
multipart/form-data |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"cnpj": "",
"logradouro": "",
"numero": "",
"bairro": "",
"cidade": "",
"estado": "",
"fone1": "",
"status": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"tipo_cliente_id": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/cliente[/:cliente_id]"
}
}
"nome": "",
"cnpj": "",
"logradouro": "",
"numero": "",
"bairro": "",
"cidade": "",
"estado": "",
"fone1": "",
"status": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"tipo_cliente_id": ""
}
DELETE /cliente[/:cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | Razão social Máximo de 128 caracteres |
YES |
| logradouro | string | Nome da rua Máximo 128 caracteres |
YES |
| numero | string | Número Máximo 10 caracteres |
YES |
| bairro | string | Bairro Máximo 128 caracteres |
YES |
| cidade | string | Máximo 64 caracteres |
YES |
| estado | string | UF |
YES |
| fone1 | YES | ||
| status | YES | ||
| data_cad | YES | ||
| user_cad | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| tipo_cliente | YES | ||
| inscricao | string | Inscrição Máximo 128 caracteres |
NO |
| compl | string | Complemento do endereço Máximo 128 caracteres |
NO |
| cep | string | Máximo 9 caracteres Formato: 99999-999 |
NO |
| cnpj | text | YES | |
| site | NO | ||
| marcas | text | YES | |
| status_fiscal | text | YES | |
| celular | text | YES | |
| pais | text | NO | |
| regime_tributario | text | YES | |
| fone2 | text | NO | |
| contato | text | NO | |
| cargo | text | NO | |
| imagem | NO | ||
| produto_cliente | YES | ||
| date_foundation | string | Data de Fundação Máximo de 10 caracteres |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Config
Configurações
GET /config
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| root_site | YES | ||
| empresa_system | YES | ||
| email_system | YES | ||
| email_projetista | YES | ||
| acesso_user | YES | ||
| evento | YES | ||
| user_cad | YES | ||
| user_upd | YES | ||
| cliente | YES | ||
| url_credencial | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/config"
},
"first": {
"href": "/config?page={page}"
},
"prev": {
"href": "/config?page={page}"
},
"next": {
"href": "/config?page={page}"
},
"last": {
"href": "/config?page={page}"
}
}
"_embedded": {
"config": [
{
"_links": {
"self": {
"href": "/config[/:config_id]"
}
}
"root_site": "",
"empresa_system": "",
"email_system": "",
"email_projetista": "",
"acesso_user": "",
"evento": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
]
}
}
POST /config
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| root_site | YES | ||
| empresa_system | YES | ||
| email_system | YES | ||
| email_projetista | YES | ||
| acesso_user | YES | ||
| evento | YES | ||
| user_cad | YES | ||
| user_upd | YES | ||
| cliente | YES | ||
| url_credencial | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /config[/:config_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| root_site | YES | ||
| empresa_system | YES | ||
| email_system | YES | ||
| email_projetista | YES | ||
| acesso_user | YES | ||
| evento | YES | ||
| user_cad | YES | ||
| user_upd | YES | ||
| cliente | YES | ||
| url_credencial | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/config[/:config_id]"
}
}
"root_site": "",
"empresa_system": "",
"email_system": "",
"email_projetista": "",
"acesso_user": "",
"evento": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
PATCH /config[/:config_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| root_site | YES | ||
| empresa_system | YES | ||
| email_system | YES | ||
| email_projetista | YES | ||
| acesso_user | YES | ||
| evento | YES | ||
| user_cad | YES | ||
| user_upd | YES | ||
| cliente | YES | ||
| url_credencial | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /config[/:config_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| root_site | YES | ||
| empresa_system | YES | ||
| email_system | YES | ||
| email_projetista | YES | ||
| acesso_user | YES | ||
| evento | YES | ||
| user_cad | YES | ||
| user_upd | YES | ||
| cliente | YES | ||
| url_credencial | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"root_site": "",
"empresa_system": "",
"email_system": "",
"email_projetista": "",
"acesso_user": "",
"evento": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/config[/:config_id]"
}
}
"root_site": "",
"empresa_system": "",
"email_system": "",
"email_projetista": "",
"acesso_user": "",
"evento": "",
"data_cad": "",
"user_cad": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
DELETE /config[/:config_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| root_site | YES | ||
| empresa_system | YES | ||
| email_system | YES | ||
| email_projetista | YES | ||
| acesso_user | YES | ||
| evento | YES | ||
| user_cad | YES | ||
| user_upd | YES | ||
| cliente | YES | ||
| url_credencial | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
ContatoCliente
GET /contatocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | Nome do contato |
YES | |
E-mail do contato |
NO | ||
| fone | Fone do contato |
NO | |
| cliente | Id do Cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /contatocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | Nome do contato |
YES | |
E-mail do contato |
NO | ||
| fone | Fone do contato |
NO | |
| cliente | Id do Cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /contatocliente[/:contato_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | Nome do contato |
YES | |
E-mail do contato |
NO | ||
| fone | Fone do contato |
NO | |
| cliente | Id do Cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /contatocliente[/:contato_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | Nome do contato |
YES | |
E-mail do contato |
NO | ||
| fone | Fone do contato |
NO | |
| cliente | Id do Cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /contatocliente[/:contato_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | Nome do contato |
YES | |
E-mail do contato |
NO | ||
| fone | Fone do contato |
NO | |
| cliente | Id do Cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /contatocliente[/:contato_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | Nome do contato |
YES | |
E-mail do contato |
NO | ||
| fone | Fone do contato |
NO | |
| cliente | Id do Cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
CredenciamentoCliente
Credenciamento Cliente
GET /credenciamentocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| empresa | YES | ||
| status | YES | ||
| representante | NO | ||
| data_inc | YES | ||
| user_upd | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| data_upd | text | YES | |
| staff_doc | text | NO | |
| staff_doc_file | text | NO | |
| image_qrcode | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/credenciamentocliente"
},
"first": {
"href": "/credenciamentocliente?page={page}"
},
"prev": {
"href": "/credenciamentocliente?page={page}"
},
"next": {
"href": "/credenciamentocliente?page={page}"
},
"last": {
"href": "/credenciamentocliente?page={page}"
}
}
"_embedded": {
"credenciamento_cliente": [
{
"_links": {
"self": {
"href": "/credenciamentocliente[/:credenciamento_cliente_id]"
}
}
"nome": "",
"cargo": "",
"empresa": "",
"status": "",
"representante": "",
"data_inc": "",
"user_upd": "",
"user_inc": "",
"cliente": ""
}
]
}
}
POST /credenciamentocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| empresa | YES | ||
| status | YES | ||
| representante | NO | ||
| data_inc | YES | ||
| user_upd | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| data_upd | text | YES | |
| staff_doc | text | NO | |
| staff_doc_file | text | NO | |
| image_qrcode | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"cargo": "",
"empresa": "",
"status": "",
"representante": "",
"data_inc": "",
"user_upd": "",
"user_inc": "",
"cliente": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/credenciamentocliente[/:credenciamento_cliente_id]"
}
}
"nome": "",
"cargo": "",
"empresa": "",
"status": "",
"representante": "",
"data_inc": "",
"user_upd": "",
"user_inc": "",
"cliente": ""
}
GET /credenciamentocliente[/:credenciamento_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| empresa | YES | ||
| status | YES | ||
| representante | NO | ||
| data_inc | YES | ||
| user_upd | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| data_upd | text | YES | |
| staff_doc | text | NO | |
| staff_doc_file | text | NO | |
| image_qrcode | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/credenciamentocliente[/:credenciamento_cliente_id]"
}
}
"nome": "",
"cargo": "",
"empresa": "",
"status": "",
"representante": "",
"data_inc": "",
"user_upd": "",
"user_inc": "",
"cliente": ""
}
PATCH /credenciamentocliente[/:credenciamento_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| empresa | YES | ||
| status | YES | ||
| representante | NO | ||
| data_inc | YES | ||
| user_upd | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| data_upd | text | YES | |
| staff_doc | text | NO | |
| staff_doc_file | text | NO | |
| image_qrcode | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /credenciamentocliente[/:credenciamento_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| empresa | YES | ||
| status | YES | ||
| representante | NO | ||
| data_inc | YES | ||
| user_upd | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| data_upd | text | YES | |
| staff_doc | text | NO | |
| staff_doc_file | text | NO | |
| image_qrcode | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"cargo": "",
"empresa": "",
"status": "",
"representante": "",
"data_inc": "",
"user_upd": "",
"user_inc": "",
"cliente": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/credenciamentocliente[/:credenciamento_cliente_id]"
}
}
"nome": "",
"cargo": "",
"empresa": "",
"status": "",
"representante": "",
"data_inc": "",
"user_upd": "",
"user_inc": "",
"cliente": ""
}
DELETE /credenciamentocliente[/:credenciamento_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| empresa | YES | ||
| status | YES | ||
| representante | NO | ||
| data_inc | YES | ||
| user_upd | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| data_upd | text | YES | |
| staff_doc | text | NO | |
| staff_doc_file | text | NO | |
| image_qrcode | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
CredenciamentoStaff
GET /credenciamentostaff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /credenciamentostaff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /credenciamentostaff[/:credenciamento_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /credenciamentostaff[/:credenciamento_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /credenciamentostaff[/:credenciamento_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /credenciamentostaff[/:credenciamento_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cargo | YES | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Documentacao
GET /documentacao
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| arquivo | YES | ||
| descricao | NO | ||
| status | YES | ||
| evento | YES | ||
| tipo_documento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/documentacao"
},
"first": {
"href": "/documentacao?page={page}"
},
"prev": {
"href": "/documentacao?page={page}"
},
"next": {
"href": "/documentacao?page={page}"
},
"last": {
"href": "/documentacao?page={page}"
}
}
"_embedded": {
"documentacao": [
{
"_links": {
"self": {
"href": "/documentacao[/:documentacao_id]"
}
}
"nome": "",
"arquivo": "",
"descricao": "",
"status": "",
"evento": "",
"tipo_documento": ""
}
]
}
}
POST /documentacao
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| arquivo | YES | ||
| descricao | NO | ||
| status | YES | ||
| evento | YES | ||
| tipo_documento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"arquivo": "",
"descricao": "",
"status": "",
"evento": "",
"tipo_documento": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/documentacao[/:documentacao_id]"
}
}
"nome": "",
"arquivo": "",
"descricao": "",
"status": "",
"evento": "",
"tipo_documento": ""
}
GET /documentacao[/:documentacao_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| arquivo | YES | ||
| descricao | NO | ||
| status | YES | ||
| evento | YES | ||
| tipo_documento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/documentacao[/:documentacao_id]"
}
}
"nome": "",
"arquivo": "",
"descricao": "",
"status": "",
"evento": "",
"tipo_documento": ""
}
PATCH /documentacao[/:documentacao_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| arquivo | YES | ||
| descricao | NO | ||
| status | YES | ||
| evento | YES | ||
| tipo_documento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /documentacao[/:documentacao_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| arquivo | YES | ||
| descricao | NO | ||
| status | YES | ||
| evento | YES | ||
| tipo_documento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"arquivo": "",
"descricao": "",
"status": "",
"evento": "",
"tipo_documento": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/documentacao[/:documentacao_id]"
}
}
"nome": "",
"arquivo": "",
"descricao": "",
"status": "",
"evento": "",
"tipo_documento": ""
}
DELETE /documentacao[/:documentacao_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| arquivo | YES | ||
| descricao | NO | ||
| status | YES | ||
| evento | YES | ||
| tipo_documento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
EquipamentoKwa
GET /equipamentokwa
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| consumo | YES | ||
| user_inc | YES | ||
| user_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /equipamentokwa
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| consumo | YES | ||
| user_inc | YES | ||
| user_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /equipamentokwa[/:equipamento_kwa_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| consumo | YES | ||
| user_inc | YES | ||
| user_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /equipamentokwa[/:equipamento_kwa_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| consumo | YES | ||
| user_inc | YES | ||
| user_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /equipamentokwa[/:equipamento_kwa_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| consumo | YES | ||
| user_inc | YES | ||
| user_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /equipamentokwa[/:equipamento_kwa_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| consumo | YES | ||
| user_inc | YES | ||
| user_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
EstandeTipo
Estante tipo
GET /estandetipo
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | nome do estande |
YES |
| color | YES | ||
| fonte_color | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/estandetipo"
},
"first": {
"href": "/estandetipo?page={page}"
},
"prev": {
"href": "/estandetipo?page={page}"
},
"next": {
"href": "/estandetipo?page={page}"
},
"last": {
"href": "/estandetipo?page={page}"
}
}
"_embedded": {
"estande_tipo": [
{
"_links": {
"self": {
"href": "/estandetipo[/:estande_tipo_id]"
}
}
"nome": "",
"color": "",
"fonte_color": "",
"evento": ""
}
]
}
}
POST /estandetipo
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | nome do estande |
YES |
| color | YES | ||
| fonte_color | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"color": "",
"fonte_color": "",
"evento": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/estandetipo[/:estande_tipo_id]"
}
}
"nome": "",
"color": "",
"fonte_color": "",
"evento": ""
}
GET /estandetipo[/:estande_tipo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | nome do estande |
YES |
| color | YES | ||
| fonte_color | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/estandetipo[/:estande_tipo_id]"
}
}
"nome": "",
"color": "",
"fonte_color": "",
"evento": ""
}
PATCH /estandetipo[/:estande_tipo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | nome do estande |
YES |
| color | YES | ||
| fonte_color | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /estandetipo[/:estande_tipo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | nome do estande |
YES |
| color | YES | ||
| fonte_color | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"color": "",
"fonte_color": "",
"evento": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/estandetipo[/:estande_tipo_id]"
}
}
"nome": "",
"color": "",
"fonte_color": "",
"evento": ""
}
DELETE /estandetipo[/:estande_tipo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | string | nome do estande |
YES |
| color | YES | ||
| fonte_color | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Estande
GET /estande
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| descricao | NO | ||
| image | NO | ||
| posx | YES | ||
| posy | YES | ||
| mapa_level | YES | ||
| pedido | YES | ||
| estande_tipo | YES | ||
| rua | NO | ||
| corredor | NO | ||
| evento | NO | ||
| produtos_cliente | array | Produtos cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/estande"
},
"first": {
"href": "/estande?page={page}"
},
"prev": {
"href": "/estande?page={page}"
},
"next": {
"href": "/estande?page={page}"
},
"last": {
"href": "/estande?page={page}"
}
}
"_embedded": {
"estande": [
{
"_links": {
"self": {
"href": "/estande[/:estande_id]"
}
}
"nome": "",
"label": "",
"descricao": "",
"image": "",
"posx": "",
"posy": "",
"mapa_level": "",
"pedido": "",
"estande_tipo": ""
}
]
}
}
POST /estande
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| descricao | NO | ||
| image | NO | ||
| posx | YES | ||
| posy | YES | ||
| mapa_level | YES | ||
| pedido | YES | ||
| estande_tipo | YES | ||
| rua | NO | ||
| corredor | NO | ||
| evento | NO | ||
| produtos_cliente | array | Produtos cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"label": "",
"descricao": "",
"image": "",
"posx": "",
"posy": "",
"mapa_level": "",
"pedido": "",
"estande_tipo": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/estande[/:estande_id]"
}
}
"nome": "",
"label": "",
"descricao": "",
"image": "",
"posx": "",
"posy": "",
"mapa_level": "",
"pedido": "",
"estande_tipo": ""
}
GET /estande[/:estande_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| descricao | NO | ||
| image | NO | ||
| posx | YES | ||
| posy | YES | ||
| mapa_level | YES | ||
| pedido | YES | ||
| estande_tipo | YES | ||
| rua | NO | ||
| corredor | NO | ||
| evento | NO | ||
| produtos_cliente | array | Produtos cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/estande[/:estande_id]"
}
}
"nome": "",
"label": "",
"descricao": "",
"image": "",
"posx": "",
"posy": "",
"mapa_level": "",
"pedido": "",
"estande_tipo": ""
}
PATCH /estande[/:estande_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| descricao | NO | ||
| image | NO | ||
| posx | YES | ||
| posy | YES | ||
| mapa_level | YES | ||
| pedido | YES | ||
| estande_tipo | YES | ||
| rua | NO | ||
| corredor | NO | ||
| evento | NO | ||
| produtos_cliente | array | Produtos cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /estande[/:estande_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| descricao | NO | ||
| image | NO | ||
| posx | YES | ||
| posy | YES | ||
| mapa_level | YES | ||
| pedido | YES | ||
| estande_tipo | YES | ||
| rua | NO | ||
| corredor | NO | ||
| evento | NO | ||
| produtos_cliente | array | Produtos cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"label": "",
"descricao": "",
"image": "",
"posx": "",
"posy": "",
"mapa_level": "",
"pedido": "",
"estande_tipo": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/estande[/:estande_id]"
}
}
"nome": "",
"label": "",
"descricao": "",
"image": "",
"posx": "",
"posy": "",
"mapa_level": "",
"pedido": "",
"estande_tipo": ""
}
DELETE /estande[/:estande_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| descricao | NO | ||
| image | NO | ||
| posx | YES | ||
| posy | YES | ||
| mapa_level | YES | ||
| pedido | YES | ||
| estande_tipo | YES | ||
| rua | NO | ||
| corredor | NO | ||
| evento | NO | ||
| produtos_cliente | array | Produtos cliente |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
EventSpeaker
GET /eventspeaker
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | text | Nome do palestrante |
YES |
| image | string | Imagem do palestrante |
NO |
| email_contact | string | Email do palestrante |
NO |
| description | string | Descrição do palestrante |
NO |
| social_networks | string | Redes sociais do palestrante |
NO |
| user_inc | int | ID do usuário |
YES |
| user_upd | int | Id do usuário |
YES |
| date_inc | bolean | Data de cadastro |
YES |
| date_upd | bolean | Data de atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /eventspeaker
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | text | Nome do palestrante |
YES |
| image | string | Imagem do palestrante |
NO |
| email_contact | string | Email do palestrante |
NO |
| description | string | Descrição do palestrante |
NO |
| social_networks | string | Redes sociais do palestrante |
NO |
| user_inc | int | ID do usuário |
YES |
| user_upd | int | Id do usuário |
YES |
| date_inc | bolean | Data de cadastro |
YES |
| date_upd | bolean | Data de atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /eventspeaker[/:event_speaker_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | text | Nome do palestrante |
YES |
| image | string | Imagem do palestrante |
NO |
| email_contact | string | Email do palestrante |
NO |
| description | string | Descrição do palestrante |
NO |
| social_networks | string | Redes sociais do palestrante |
NO |
| user_inc | int | ID do usuário |
YES |
| user_upd | int | Id do usuário |
YES |
| date_inc | bolean | Data de cadastro |
YES |
| date_upd | bolean | Data de atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /eventspeaker[/:event_speaker_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | text | Nome do palestrante |
YES |
| image | string | Imagem do palestrante |
NO |
| email_contact | string | Email do palestrante |
NO |
| description | string | Descrição do palestrante |
NO |
| social_networks | string | Redes sociais do palestrante |
NO |
| user_inc | int | ID do usuário |
YES |
| user_upd | int | Id do usuário |
YES |
| date_inc | bolean | Data de cadastro |
YES |
| date_upd | bolean | Data de atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /eventspeaker[/:event_speaker_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | text | Nome do palestrante |
YES |
| image | string | Imagem do palestrante |
NO |
| email_contact | string | Email do palestrante |
NO |
| description | string | Descrição do palestrante |
NO |
| social_networks | string | Redes sociais do palestrante |
NO |
| user_inc | int | ID do usuário |
YES |
| user_upd | int | Id do usuário |
YES |
| date_inc | bolean | Data de cadastro |
YES |
| date_upd | bolean | Data de atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /eventspeaker[/:event_speaker_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name | text | Nome do palestrante |
YES |
| image | string | Imagem do palestrante |
NO |
| email_contact | string | Email do palestrante |
NO |
| description | string | Descrição do palestrante |
NO |
| social_networks | string | Redes sociais do palestrante |
NO |
| user_inc | int | ID do usuário |
YES |
| user_upd | int | Id do usuário |
YES |
| date_inc | bolean | Data de cadastro |
YES |
| date_upd | bolean | Data de atualização |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
EventoStaff
GET /eventostaff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /eventostaff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /eventostaff[/:evento_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /eventostaff[/:evento_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /eventostaff[/:evento_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /eventostaff[/:evento_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Evento
GET /evento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| edicao | NO | ||
| local_evento | YES | ||
| data_ini | YES | ||
| data_fim | YES | ||
| url | NO | ||
| descricao | NO | ||
| imagem | NO | ||
| planta | NO | ||
| data_prazo_montagem | NO | ||
| valor_montagem_antecipado | NO | ||
| valor_montagem | NO | ||
| data_planta | NO | ||
| data_montadora | NO | ||
| data_credenciamento | NO | ||
| cred_evento | NO | ||
| cred_antecipado | NO | ||
| user_inc | YES | ||
| user_upd | YES | ||
| data_inc | YES | ||
| data_upd | YES | ||
| traslado | NO | ||
| url_credenciamento | string | LInk para credenciamento externo |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /evento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| edicao | NO | ||
| local_evento | YES | ||
| data_ini | YES | ||
| data_fim | YES | ||
| url | NO | ||
| descricao | NO | ||
| imagem | NO | ||
| planta | NO | ||
| data_prazo_montagem | NO | ||
| valor_montagem_antecipado | NO | ||
| valor_montagem | NO | ||
| data_planta | NO | ||
| data_montadora | NO | ||
| data_credenciamento | NO | ||
| cred_evento | NO | ||
| cred_antecipado | NO | ||
| user_inc | YES | ||
| user_upd | YES | ||
| data_inc | YES | ||
| data_upd | YES | ||
| traslado | NO | ||
| url_credenciamento | string | LInk para credenciamento externo |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /evento[/:evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| edicao | NO | ||
| local_evento | YES | ||
| data_ini | YES | ||
| data_fim | YES | ||
| url | NO | ||
| descricao | NO | ||
| imagem | NO | ||
| planta | NO | ||
| data_prazo_montagem | NO | ||
| valor_montagem_antecipado | NO | ||
| valor_montagem | NO | ||
| data_planta | NO | ||
| data_montadora | NO | ||
| data_credenciamento | NO | ||
| cred_evento | NO | ||
| cred_antecipado | NO | ||
| user_inc | YES | ||
| user_upd | YES | ||
| data_inc | YES | ||
| data_upd | YES | ||
| traslado | NO | ||
| url_credenciamento | string | LInk para credenciamento externo |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /evento[/:evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| edicao | NO | ||
| local_evento | YES | ||
| data_ini | YES | ||
| data_fim | YES | ||
| url | NO | ||
| descricao | NO | ||
| imagem | NO | ||
| planta | NO | ||
| data_prazo_montagem | NO | ||
| valor_montagem_antecipado | NO | ||
| valor_montagem | NO | ||
| data_planta | NO | ||
| data_montadora | NO | ||
| data_credenciamento | NO | ||
| cred_evento | NO | ||
| cred_antecipado | NO | ||
| user_inc | YES | ||
| user_upd | YES | ||
| data_inc | YES | ||
| data_upd | YES | ||
| traslado | NO | ||
| url_credenciamento | string | LInk para credenciamento externo |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /evento[/:evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| edicao | NO | ||
| local_evento | YES | ||
| data_ini | YES | ||
| data_fim | YES | ||
| url | NO | ||
| descricao | NO | ||
| imagem | NO | ||
| planta | NO | ||
| data_prazo_montagem | NO | ||
| valor_montagem_antecipado | NO | ||
| valor_montagem | NO | ||
| data_planta | NO | ||
| data_montadora | NO | ||
| data_credenciamento | NO | ||
| cred_evento | NO | ||
| cred_antecipado | NO | ||
| user_inc | YES | ||
| user_upd | YES | ||
| data_inc | YES | ||
| data_upd | YES | ||
| traslado | NO | ||
| url_credenciamento | string | LInk para credenciamento externo |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /evento[/:evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| edicao | NO | ||
| local_evento | YES | ||
| data_ini | YES | ||
| data_fim | YES | ||
| url | NO | ||
| descricao | NO | ||
| imagem | NO | ||
| planta | NO | ||
| data_prazo_montagem | NO | ||
| valor_montagem_antecipado | NO | ||
| valor_montagem | NO | ||
| data_planta | NO | ||
| data_montadora | NO | ||
| data_credenciamento | NO | ||
| cred_evento | NO | ||
| cred_antecipado | NO | ||
| user_inc | YES | ||
| user_upd | YES | ||
| data_inc | YES | ||
| data_upd | YES | ||
| traslado | NO | ||
| url_credenciamento | string | LInk para credenciamento externo |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
GuardaMalas
Guarda malas
GET /guardamalas
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| documento | YES | ||
| fone | YES | ||
| fone_inter | YES | ||
| qtd_volume | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| status | YES | ||
| observacao | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/guardamalas"
},
"first": {
"href": "/guardamalas?page={page}"
},
"prev": {
"href": "/guardamalas?page={page}"
},
"next": {
"href": "/guardamalas?page={page}"
},
"last": {
"href": "/guardamalas?page={page}"
}
}
"_embedded": {
"guarda_malas": [
{
"_links": {
"self": {
"href": "/guardamalas[/:guarda_malas_id]"
}
}
"nome": "",
"documento": "",
"fone": "",
"fone_inter": "",
"qtd_volume": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"status": "",
"observacao": "",
"evento": ""
}
]
}
}
POST /guardamalas
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| documento | YES | ||
| fone | YES | ||
| fone_inter | YES | ||
| qtd_volume | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| status | YES | ||
| observacao | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": "",
"documento": "",
"fone": "",
"fone_inter": "",
"qtd_volume": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"status": "",
"observacao": "",
"evento": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/guardamalas[/:guarda_malas_id]"
}
}
"nome": "",
"documento": "",
"fone": "",
"fone_inter": "",
"qtd_volume": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"status": "",
"observacao": "",
"evento": ""
}
GET /guardamalas[/:guarda_malas_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| documento | YES | ||
| fone | YES | ||
| fone_inter | YES | ||
| qtd_volume | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| status | YES | ||
| observacao | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/guardamalas[/:guarda_malas_id]"
}
}
"nome": "",
"documento": "",
"fone": "",
"fone_inter": "",
"qtd_volume": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"status": "",
"observacao": "",
"evento": ""
}
PATCH /guardamalas[/:guarda_malas_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| documento | YES | ||
| fone | YES | ||
| fone_inter | YES | ||
| qtd_volume | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| status | YES | ||
| observacao | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /guardamalas[/:guarda_malas_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| documento | YES | ||
| fone | YES | ||
| fone_inter | YES | ||
| qtd_volume | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| status | YES | ||
| observacao | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": "",
"documento": "",
"fone": "",
"fone_inter": "",
"qtd_volume": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"status": "",
"observacao": "",
"evento": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/guardamalas[/:guarda_malas_id]"
}
}
"nome": "",
"documento": "",
"fone": "",
"fone_inter": "",
"qtd_volume": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"status": "",
"observacao": "",
"evento": ""
}
DELETE /guardamalas[/:guarda_malas_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| documento | YES | ||
| fone | YES | ||
| fone_inter | YES | ||
| qtd_volume | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| status | YES | ||
| observacao | YES | ||
| evento | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
HistoricoCliente
Histórico Cliente
GET /historicocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| descricao | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/historicocliente"
},
"first": {
"href": "/historicocliente?page={page}"
},
"prev": {
"href": "/historicocliente?page={page}"
},
"next": {
"href": "/historicocliente?page={page}"
},
"last": {
"href": "/historicocliente?page={page}"
}
}
"_embedded": {
"historico_cliente": [
{
"_links": {
"self": {
"href": "/historicocliente[/:historico_cliente_id]"
}
}
"descricao": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
]
}
}
POST /historicocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| descricao | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /historicocliente[/:historico_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| descricao | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/historicocliente[/:historico_cliente_id]"
}
}
"descricao": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
PATCH /historicocliente[/:historico_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| descricao | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"descricao": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/historicocliente[/:historico_cliente_id]"
}
}
"descricao": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
PUT /historicocliente[/:historico_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| descricao | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"descricao": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/historicocliente[/:historico_cliente_id]"
}
}
"descricao": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"cliente": ""
}
DELETE /historicocliente[/:historico_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| descricao | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
MapaLevel
GET /mapalevel
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| planta_baixa | YES | ||
| mini_map | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| evento | YES | ||
| image_size | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/mapalevel"
},
"first": {
"href": "/mapalevel?page={page}"
},
"prev": {
"href": "/mapalevel?page={page}"
},
"next": {
"href": "/mapalevel?page={page}"
},
"last": {
"href": "/mapalevel?page={page}"
}
}
"_embedded": {
"mapa_level": [
{
"_links": {
"self": {
"href": "/mapalevel[/:mapa_level_id]"
}
}
"nome": "",
"label": "",
"planta_baixa": "",
"mini_map": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"evento": "",
"image_size": ""
}
]
}
}
POST /mapalevel
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| planta_baixa | YES | ||
| mini_map | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| evento | YES | ||
| image_size | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"label": "",
"planta_baixa": "",
"mini_map": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"evento": "",
"image_size": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/mapalevel[/:mapa_level_id]"
}
}
"nome": "",
"label": "",
"planta_baixa": "",
"mini_map": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"evento": "",
"image_size": ""
}
GET /mapalevel[/:mapa_level_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| planta_baixa | YES | ||
| mini_map | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| evento | YES | ||
| image_size | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/mapalevel[/:mapa_level_id]"
}
}
"nome": "",
"label": "",
"planta_baixa": "",
"mini_map": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"evento": "",
"image_size": ""
}
PATCH /mapalevel[/:mapa_level_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| planta_baixa | YES | ||
| mini_map | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| evento | YES | ||
| image_size | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /mapalevel[/:mapa_level_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| planta_baixa | YES | ||
| mini_map | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| evento | YES | ||
| image_size | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"label": "",
"planta_baixa": "",
"mini_map": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"evento": "",
"image_size": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/mapalevel[/:mapa_level_id]"
}
}
"nome": "",
"label": "",
"planta_baixa": "",
"mini_map": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"evento": "",
"image_size": ""
}
DELETE /mapalevel[/:mapa_level_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES | ||
| planta_baixa | YES | ||
| mini_map | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| evento | YES | ||
| image_size | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
MarcasEvento
GET /marcasevento
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /marcasevento
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /marcasevento[/:marcas_evento_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /marcasevento[/:marcas_evento_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /marcasevento[/:marcas_evento_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /marcasevento[/:marcas_evento_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
NotificacaoPlanta
Notificação de plantas do estande
GET /notificacaoplanta
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_envio | YES | ||
| YES | |||
| planta_estande | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/notificacaoplanta"
},
"first": {
"href": "/notificacaoplanta?page={page}"
},
"prev": {
"href": "/notificacaoplanta?page={page}"
},
"next": {
"href": "/notificacaoplanta?page={page}"
},
"last": {
"href": "/notificacaoplanta?page={page}"
}
}
"_embedded": {
"notificacao_planta": [
{
"_links": {
"self": {
"href": "/notificacaoplanta[/:notificacao_planta_id]"
}
}
"data_envio": "",
"email": "",
"planta_estande": ""
}
]
}
}
POST /notificacaoplanta
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_envio | YES | ||
| YES | |||
| planta_estande | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"data_envio": "",
"email": "",
"planta_estande": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/notificacaoplanta[/:notificacao_planta_id]"
}
}
"data_envio": "",
"email": "",
"planta_estande": ""
}
GET /notificacaoplanta[/:notificacao_planta_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_envio | YES | ||
| YES | |||
| planta_estande | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/notificacaoplanta[/:notificacao_planta_id]"
}
}
"data_envio": "",
"email": "",
"planta_estande": ""
}
PATCH /notificacaoplanta[/:notificacao_planta_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_envio | YES | ||
| YES | |||
| planta_estande | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"data_envio": "",
"email": "",
"planta_estande": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/notificacaoplanta[/:notificacao_planta_id]"
}
}
"data_envio": "",
"email": "",
"planta_estande": ""
}
PUT /notificacaoplanta[/:notificacao_planta_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_envio | YES | ||
| YES | |||
| planta_estande | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"data_envio": "",
"email": "",
"planta_estande": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/notificacaoplanta[/:notificacao_planta_id]"
}
}
"data_envio": "",
"email": "",
"planta_estande": ""
}
DELETE /notificacaoplanta[/:notificacao_planta_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_envio | YES | ||
| YES | |||
| planta_estande | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Pavilhao
CRUD pavilhão
GET /pavilhao
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pavilhao"
},
"first": {
"href": "/pavilhao?page={page}"
},
"prev": {
"href": "/pavilhao?page={page}"
},
"next": {
"href": "/pavilhao?page={page}"
},
"last": {
"href": "/pavilhao?page={page}"
}
}
"_embedded": {
"pavilhao": [
{
"_links": {
"self": {
"href": "/pavilhao[/:pavilhao_id]"
}
}
"nome": ""
}
]
}
}
POST /pavilhao
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pavilhao[/:pavilhao_id]"
}
}
"nome": ""
}
GET /pavilhao[/:pavilhao_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pavilhao[/:pavilhao_id]"
}
}
"nome": ""
}
PATCH /pavilhao[/:pavilhao_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /pavilhao[/:pavilhao_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pavilhao[/:pavilhao_id]"
}
}
"nome": ""
}
DELETE /pavilhao[/:pavilhao_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
PaymentClientControl
GET /paymentclientcontrol
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| price | Inteiro | text |
YES |
| qtd_print | text | Quantidade de impressões |
NO |
| status | boolean | Status do pagamento |
YES |
| montadora_id | inteiro | ID da Montadora |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /paymentclientcontrol
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| price | Inteiro | text |
YES |
| qtd_print | text | Quantidade de impressões |
NO |
| status | boolean | Status do pagamento |
YES |
| montadora_id | inteiro | ID da Montadora |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /paymentclientcontrol[/:payment_client_control_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| price | Inteiro | text |
YES |
| qtd_print | text | Quantidade de impressões |
NO |
| status | boolean | Status do pagamento |
YES |
| montadora_id | inteiro | ID da Montadora |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /paymentclientcontrol[/:payment_client_control_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| price | Inteiro | text |
YES |
| qtd_print | text | Quantidade de impressões |
NO |
| status | boolean | Status do pagamento |
YES |
| montadora_id | inteiro | ID da Montadora |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /paymentclientcontrol[/:payment_client_control_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| price | Inteiro | text |
YES |
| qtd_print | text | Quantidade de impressões |
NO |
| status | boolean | Status do pagamento |
YES |
| montadora_id | inteiro | ID da Montadora |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /paymentclientcontrol[/:payment_client_control_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| price | Inteiro | text |
YES |
| qtd_print | text | Quantidade de impressões |
NO |
| status | boolean | Status do pagamento |
YES |
| montadora_id | inteiro | ID da Montadora |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
PedidoKwa
Lista de equipamentos com consumo de KWA do estande
GET /pedidokwa
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| qtd_equipamento | YES | ||
| valor | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| equipamento_kwa | YES | ||
| pedido | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pedidokwa"
},
"first": {
"href": "/pedidokwa?page={page}"
},
"prev": {
"href": "/pedidokwa?page={page}"
},
"next": {
"href": "/pedidokwa?page={page}"
},
"last": {
"href": "/pedidokwa?page={page}"
}
}
"_embedded": {
"pedido_kwa": [
{
"_links": {
"self": {
"href": "/pedidokwa[/:pedido_kwa_id]"
}
}
"qtd_equipamento": "",
"valor": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"equipamento_kwa": "",
"pedido": ""
}
]
}
}
POST /pedidokwa
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| qtd_equipamento | YES | ||
| valor | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| equipamento_kwa | YES | ||
| pedido | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /pedidokwa[/:pedido_kwa_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| qtd_equipamento | YES | ||
| valor | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| equipamento_kwa | YES | ||
| pedido | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pedidokwa[/:pedido_kwa_id]"
}
}
"qtd_equipamento": "",
"valor": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"equipamento_kwa": "",
"pedido": ""
}
PATCH /pedidokwa[/:pedido_kwa_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| qtd_equipamento | YES | ||
| valor | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| equipamento_kwa | YES | ||
| pedido | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /pedidokwa[/:pedido_kwa_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| qtd_equipamento | YES | ||
| valor | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| equipamento_kwa | YES | ||
| pedido | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"qtd_equipamento": "",
"valor": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"equipamento_kwa": "",
"pedido": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pedidokwa[/:pedido_kwa_id]"
}
}
"qtd_equipamento": "",
"valor": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"equipamento_kwa": "",
"pedido": ""
}
DELETE /pedidokwa[/:pedido_kwa_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| qtd_equipamento | YES | ||
| valor | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| equipamento_kwa | YES | ||
| pedido | YES | ||
| data_upd | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
PedidoMontadora
GET /pedidomontadora
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_cad_montadora | Data de cadastro da montadora |
NO | |
| montadora | ID da montadora |
YES | |
| pedido | ID do pedido |
YES | |
| user_inc | ID do usuário |
YES | |
| user_upd | Id do usuário |
YES | |
| perfil_cad | inteiro | Perfil do cadastrante |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /pedidomontadora
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_cad_montadora | Data de cadastro da montadora |
NO | |
| montadora | ID da montadora |
YES | |
| pedido | ID do pedido |
YES | |
| user_inc | ID do usuário |
YES | |
| user_upd | Id do usuário |
YES | |
| perfil_cad | inteiro | Perfil do cadastrante |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /pedidomontadora[/:pedido_montadora_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_cad_montadora | Data de cadastro da montadora |
NO | |
| montadora | ID da montadora |
YES | |
| pedido | ID do pedido |
YES | |
| user_inc | ID do usuário |
YES | |
| user_upd | Id do usuário |
YES | |
| perfil_cad | inteiro | Perfil do cadastrante |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /pedidomontadora[/:pedido_montadora_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_cad_montadora | Data de cadastro da montadora |
NO | |
| montadora | ID da montadora |
YES | |
| pedido | ID do pedido |
YES | |
| user_inc | ID do usuário |
YES | |
| user_upd | Id do usuário |
YES | |
| perfil_cad | inteiro | Perfil do cadastrante |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /pedidomontadora[/:pedido_montadora_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_cad_montadora | Data de cadastro da montadora |
NO | |
| montadora | ID da montadora |
YES | |
| pedido | ID do pedido |
YES | |
| user_inc | ID do usuário |
YES | |
| user_upd | Id do usuário |
YES | |
| perfil_cad | inteiro | Perfil do cadastrante |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /pedidomontadora[/:pedido_montadora_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| data_cad_montadora | Data de cadastro da montadora |
NO | |
| montadora | ID da montadora |
YES | |
| pedido | ID do pedido |
YES | |
| user_inc | ID do usuário |
YES | |
| user_upd | Id do usuário |
YES | |
| perfil_cad | inteiro | Perfil do cadastrante |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Pedido
Contratos
GET /pedido
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| estande | YES | ||
| metragem | NO | ||
| rua | NO | ||
| corredor | NO | ||
| portao_carga | NO | ||
| observacao | NO | ||
| status_montadora | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| data_cad_montadora | NO | ||
| pavilhao | text | YES | |
| evento | text | YES | |
| cliente | text | YES | |
| marcas_pedido | NO | ||
| historico | NO | ||
| status | YES | ||
| montadora | NO | ||
| perfil_cad | inteiro | Perfil do cadastrante |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pedido"
},
"first": {
"href": "/pedido?page={page}"
},
"prev": {
"href": "/pedido?page={page}"
},
"next": {
"href": "/pedido?page={page}"
},
"last": {
"href": "/pedido?page={page}"
}
}
"_embedded": {
"pedido": [
{
"_links": {
"self": {
"href": "/pedido[/:pedido_id]"
}
}
"estande": "",
"metragem": "",
"rua": "",
"corredor": "",
"portao_carga": "",
"observacao": "",
"status_montadora": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"data_cad_montadora": "",
"pavilhao_id": "",
"evento_id": "",
"cliente_id": ""
}
]
}
}
POST /pedido
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| estande | YES | ||
| metragem | NO | ||
| rua | NO | ||
| corredor | NO | ||
| portao_carga | NO | ||
| observacao | NO | ||
| status_montadora | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| data_cad_montadora | NO | ||
| pavilhao | text | YES | |
| evento | text | YES | |
| cliente | text | YES | |
| marcas_pedido | NO | ||
| historico | NO | ||
| status | YES | ||
| montadora | NO | ||
| perfil_cad | inteiro | Perfil do cadastrante |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"estande": "",
"metragem": "",
"rua": "",
"corredor": "",
"portao_carga": "",
"observacao": "",
"status_montadora": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"data_cad_montadora": "",
"pavilhao_id": "",
"evento_id": "",
"cliente_id": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pedido[/:pedido_id]"
}
}
"estande": "",
"metragem": "",
"rua": "",
"corredor": "",
"portao_carga": "",
"observacao": "",
"status_montadora": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"data_cad_montadora": "",
"pavilhao_id": "",
"evento_id": "",
"cliente_id": ""
}
GET /pedido[/:pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| estande | YES | ||
| metragem | NO | ||
| rua | NO | ||
| corredor | NO | ||
| portao_carga | NO | ||
| observacao | NO | ||
| status_montadora | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| data_cad_montadora | NO | ||
| pavilhao | text | YES | |
| evento | text | YES | |
| cliente | text | YES | |
| marcas_pedido | NO | ||
| historico | NO | ||
| status | YES | ||
| montadora | NO | ||
| perfil_cad | inteiro | Perfil do cadastrante |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pedido[/:pedido_id]"
}
}
"estande": "",
"metragem": "",
"rua": "",
"corredor": "",
"portao_carga": "",
"observacao": "",
"status_montadora": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"data_cad_montadora": "",
"pavilhao_id": "",
"evento_id": "",
"cliente_id": ""
}
PATCH /pedido[/:pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| estande | YES | ||
| metragem | NO | ||
| rua | NO | ||
| corredor | NO | ||
| portao_carga | NO | ||
| observacao | NO | ||
| status_montadora | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| data_cad_montadora | NO | ||
| pavilhao | text | YES | |
| evento | text | YES | |
| cliente | text | YES | |
| marcas_pedido | NO | ||
| historico | NO | ||
| status | YES | ||
| montadora | NO | ||
| perfil_cad | inteiro | Perfil do cadastrante |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"estande": "",
"metragem": "",
"rua": "",
"corredor": "",
"portao_carga": "",
"observacao": "",
"status_montadora": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"data_cad_montadora": "",
"pavilhao_id": "",
"evento_id": "",
"cliente_id": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pedido[/:pedido_id]"
}
}
"estande": "",
"metragem": "",
"rua": "",
"corredor": "",
"portao_carga": "",
"observacao": "",
"status_montadora": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"data_cad_montadora": "",
"pavilhao_id": "",
"evento_id": "",
"cliente_id": ""
}
PUT /pedido[/:pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| estande | YES | ||
| metragem | NO | ||
| rua | NO | ||
| corredor | NO | ||
| portao_carga | NO | ||
| observacao | NO | ||
| status_montadora | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| data_cad_montadora | NO | ||
| pavilhao | text | YES | |
| evento | text | YES | |
| cliente | text | YES | |
| marcas_pedido | NO | ||
| historico | NO | ||
| status | YES | ||
| montadora | NO | ||
| perfil_cad | inteiro | Perfil do cadastrante |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"estande": "",
"metragem": "",
"rua": "",
"corredor": "",
"portao_carga": "",
"observacao": "",
"status_montadora": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"data_cad_montadora": "",
"pavilhao_id": "",
"evento_id": "",
"cliente_id": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/pedido[/:pedido_id]"
}
}
"estande": "",
"metragem": "",
"rua": "",
"corredor": "",
"portao_carga": "",
"observacao": "",
"status_montadora": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"data_cad_montadora": "",
"pavilhao_id": "",
"evento_id": "",
"cliente_id": ""
}
DELETE /pedido[/:pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| estande | YES | ||
| metragem | NO | ||
| rua | NO | ||
| corredor | NO | ||
| portao_carga | NO | ||
| observacao | NO | ||
| status_montadora | NO | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| data_cad_montadora | NO | ||
| pavilhao | text | YES | |
| evento | text | YES | |
| cliente | text | YES | |
| marcas_pedido | NO | ||
| historico | NO | ||
| status | YES | ||
| montadora | NO | ||
| perfil_cad | inteiro | Perfil do cadastrante |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Perfil
GET /perfil
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| perfilId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /perfil
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| perfilId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /perfil[/:perfil_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| perfilId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /perfil[/:perfil_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| perfilId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /perfil[/:perfil_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| perfilId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /perfil[/:perfil_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| perfilId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
PlantaEstande
Planta estande
GET /plantaestande
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| image | YES | ||
| file | NO | ||
| descricao | NO | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/plantaestande"
},
"first": {
"href": "/plantaestande?page={page}"
},
"prev": {
"href": "/plantaestande?page={page}"
},
"next": {
"href": "/plantaestande?page={page}"
},
"last": {
"href": "/plantaestande?page={page}"
}
}
"_embedded": {
"planta_estande": [
{
"_links": {
"self": {
"href": "/plantaestande[/:planta_estande_id]"
}
}
"image": "",
"file": "",
"descricao": "",
"status": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
]
}
}
POST /plantaestande
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| image | YES | ||
| file | NO | ||
| descricao | NO | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /plantaestande[/:planta_estande_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| image | YES | ||
| file | NO | ||
| descricao | NO | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/plantaestande[/:planta_estande_id]"
}
}
"image": "",
"file": "",
"descricao": "",
"status": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
PATCH /plantaestande[/:planta_estande_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| image | YES | ||
| file | NO | ||
| descricao | NO | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /plantaestande[/:planta_estande_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| image | YES | ||
| file | NO | ||
| descricao | NO | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"image": "",
"file": "",
"descricao": "",
"status": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/plantaestande[/:planta_estande_id]"
}
}
"image": "",
"file": "",
"descricao": "",
"status": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
DELETE /plantaestande[/:planta_estande_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| image | YES | ||
| file | NO | ||
| descricao | NO | ||
| status | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
ProdutoCliente
GET /produtocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /produtocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /produtocliente[/:produto_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /produtocliente[/:produto_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /produtocliente[/:produto_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /produtocliente[/:produto_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
ProgramacaoEvento
GET /programacaoevento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| data_ini | YES | ||
| data_fim | text | YES | |
| user_inc | test | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | text | YES | |
| evento | text | YES | |
| categoria_evento | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /programacaoevento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| data_ini | YES | ||
| data_fim | text | YES | |
| user_inc | test | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | text | YES | |
| evento | text | YES | |
| categoria_evento | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /programacaoevento[/:programacao_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| data_ini | YES | ||
| data_fim | text | YES | |
| user_inc | test | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | text | YES | |
| evento | text | YES | |
| categoria_evento | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /programacaoevento[/:programacao_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| data_ini | YES | ||
| data_fim | text | YES | |
| user_inc | test | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | text | YES | |
| evento | text | YES | |
| categoria_evento | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /programacaoevento[/:programacao_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| data_ini | YES | ||
| data_fim | text | YES | |
| user_inc | test | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | text | YES | |
| evento | text | YES | |
| categoria_evento | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /programacaoevento[/:programacao_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| data_ini | YES | ||
| data_fim | text | YES | |
| user_inc | test | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | text | YES | |
| evento | text | YES | |
| categoria_evento | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
ReceptivoEvento
GET /receptivoevento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| cidade_receptivo | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /receptivoevento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| cidade_receptivo | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /receptivoevento[/:receptivo_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| cidade_receptivo | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /receptivoevento[/:receptivo_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| cidade_receptivo | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /receptivoevento[/:receptivo_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| cidade_receptivo | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /receptivoevento[/:receptivo_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | YES | |
| descricao | textarea | YES | |
| image | text | YES | |
| cidade_receptivo | text | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
ReciboEvento
Recibo de eventos
GET /reciboevento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| descricao | YES | ||
| valor | YES | ||
| valor_extenso | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| evento | YES | ||
| tipo_recibo | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/reciboevento"
},
"first": {
"href": "/reciboevento?page={page}"
},
"prev": {
"href": "/reciboevento?page={page}"
},
"next": {
"href": "/reciboevento?page={page}"
},
"last": {
"href": "/reciboevento?page={page}"
}
}
"_embedded": {
"recibo_evento": [
{
"_links": {
"self": {
"href": "/reciboevento[/:recibo_evento_id]"
}
}
"nome": "",
"descricao": "",
"valor": "",
"valor_extenso": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"evento": "",
"tipo_recibo": ""
}
]
}
}
POST /reciboevento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| descricao | YES | ||
| valor | YES | ||
| valor_extenso | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| evento | YES | ||
| tipo_recibo | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": "",
"descricao": "",
"valor": "",
"valor_extenso": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"evento": "",
"tipo_recibo": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/reciboevento[/:recibo_evento_id]"
}
}
"nome": "",
"descricao": "",
"valor": "",
"valor_extenso": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"evento": "",
"tipo_recibo": ""
}
GET /reciboevento[/:recibo_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| descricao | YES | ||
| valor | YES | ||
| valor_extenso | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| evento | YES | ||
| tipo_recibo | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/reciboevento[/:recibo_evento_id]"
}
}
"nome": "",
"descricao": "",
"valor": "",
"valor_extenso": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"evento": "",
"tipo_recibo": ""
}
PATCH /reciboevento[/:recibo_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| descricao | YES | ||
| valor | YES | ||
| valor_extenso | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| evento | YES | ||
| tipo_recibo | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /reciboevento[/:recibo_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| descricao | YES | ||
| valor | YES | ||
| valor_extenso | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| evento | YES | ||
| tipo_recibo | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": "",
"descricao": "",
"valor": "",
"valor_extenso": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"evento": "",
"tipo_recibo": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/reciboevento[/:recibo_evento_id]"
}
}
"nome": "",
"descricao": "",
"valor": "",
"valor_extenso": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": "",
"evento": "",
"tipo_recibo": ""
}
DELETE /reciboevento[/:recibo_evento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| descricao | YES | ||
| valor | YES | ||
| valor_extenso | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| evento | YES | ||
| tipo_recibo | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
RegimeTributario
GET /regime-tributario
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Nome do regime tributário |
YES |
| slug | text | Slug do campo nome |
NO |
| alicota_regime | textarea | Alícotas do regime tributario nome e percentual |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /regime-tributario
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Nome do regime tributário |
YES |
| slug | text | Slug do campo nome |
NO |
| alicota_regime | textarea | Alícotas do regime tributario nome e percentual |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /regime-tributario[/:regime_tributario_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Nome do regime tributário |
YES |
| slug | text | Slug do campo nome |
NO |
| alicota_regime | textarea | Alícotas do regime tributario nome e percentual |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /regime-tributario[/:regime_tributario_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Nome do regime tributário |
YES |
| slug | text | Slug do campo nome |
NO |
| alicota_regime | textarea | Alícotas do regime tributario nome e percentual |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /regime-tributario[/:regime_tributario_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Nome do regime tributário |
YES |
| slug | text | Slug do campo nome |
NO |
| alicota_regime | textarea | Alícotas do regime tributario nome e percentual |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /regime-tributario[/:regime_tributario_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | text | Nome do regime tributário |
YES |
| slug | text | Slug do campo nome |
NO |
| alicota_regime | textarea | Alícotas do regime tributario nome e percentual |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Resource
Recurso de permissões
GET /resource
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /resource
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /resource[/:resource_id]
Coleção de registro https://api.paineldoexpositor.com.br/resource/
Buscando um registro https://api.paineldoexpositor.com.br/resource/[id_recurso]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/resource[/:resource_id]"
}
}
"nome": "",
"label": ""
}
PATCH /resource[/:resource_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /resource[/:resource_id]
Editando registro
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": "",
"label": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/resource[/:resource_id]"
}
}
"nome": "",
"label": ""
}
DELETE /resource[/:resource_id]
Deletando registro
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| label | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
ResponsavelStaff
Responsável Staff
GET /responsavelstaff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| cpf | YES | ||
| fone | YES | ||
| qtd_profissionais | NO | ||
| nome_profissionais | NO | ||
| data_inc | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| evento | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/responsavelstaff"
},
"first": {
"href": "/responsavelstaff?page={page}"
},
"prev": {
"href": "/responsavelstaff?page={page}"
},
"next": {
"href": "/responsavelstaff?page={page}"
},
"last": {
"href": "/responsavelstaff?page={page}"
}
}
"_embedded": {
"responsavel_staff": [
{
"_links": {
"self": {
"href": "/responsavelstaff[/:responsavel_staff_id]"
}
}
"nome": "",
"email": "",
"cpf": "",
"fone": "",
"qtd_profissionais": "",
"nome_profissionais": "",
"data_inc": "",
"user_inc": "",
"cliente": "",
"evento": "",
"staff": ""
}
]
}
}
POST /responsavelstaff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| cpf | YES | ||
| fone | YES | ||
| qtd_profissionais | NO | ||
| nome_profissionais | NO | ||
| data_inc | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| evento | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": "",
"email": "",
"cpf": "",
"fone": "",
"qtd_profissionais": "",
"nome_profissionais": "",
"data_inc": "",
"user_inc": "",
"cliente": "",
"evento": "",
"staff": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/responsavelstaff[/:responsavel_staff_id]"
}
}
"nome": "",
"email": "",
"cpf": "",
"fone": "",
"qtd_profissionais": "",
"nome_profissionais": "",
"data_inc": "",
"user_inc": "",
"cliente": "",
"evento": "",
"staff": ""
}
GET /responsavelstaff[/:responsavel_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| cpf | YES | ||
| fone | YES | ||
| qtd_profissionais | NO | ||
| nome_profissionais | NO | ||
| data_inc | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| evento | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/responsavelstaff[/:responsavel_staff_id]"
}
}
"nome": "",
"email": "",
"cpf": "",
"fone": "",
"qtd_profissionais": "",
"nome_profissionais": "",
"data_inc": "",
"user_inc": "",
"cliente": "",
"evento": "",
"staff": ""
}
PATCH /responsavelstaff[/:responsavel_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| cpf | YES | ||
| fone | YES | ||
| qtd_profissionais | NO | ||
| nome_profissionais | NO | ||
| data_inc | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| evento | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /responsavelstaff[/:responsavel_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| cpf | YES | ||
| fone | YES | ||
| qtd_profissionais | NO | ||
| nome_profissionais | NO | ||
| data_inc | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| evento | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": "",
"email": "",
"cpf": "",
"fone": "",
"qtd_profissionais": "",
"nome_profissionais": "",
"data_inc": "",
"user_inc": "",
"cliente": "",
"evento": "",
"staff": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/responsavelstaff[/:responsavel_staff_id]"
}
}
"nome": "",
"email": "",
"cpf": "",
"fone": "",
"qtd_profissionais": "",
"nome_profissionais": "",
"data_inc": "",
"user_inc": "",
"cliente": "",
"evento": "",
"staff": ""
}
DELETE /responsavelstaff[/:responsavel_staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| cpf | YES | ||
| fone | YES | ||
| qtd_profissionais | NO | ||
| nome_profissionais | NO | ||
| data_inc | YES | ||
| user_inc | YES | ||
| cliente | YES | ||
| evento | YES | ||
| staff | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Staff
Prestadores de Serviços
GET /staff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cnpj | YES | ||
| inscricao | NO | ||
| logradouro | YES | ||
| numero | YES | ||
| complemento | NO | ||
| bairro | YES | ||
| cidade | YES | ||
| estado | YES | ||
| cep | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| categoria_staff | YES | ||
| evento_staff | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/staff"
},
"first": {
"href": "/staff?page={page}"
},
"prev": {
"href": "/staff?page={page}"
},
"next": {
"href": "/staff?page={page}"
},
"last": {
"href": "/staff?page={page}"
}
}
"_embedded": {
"staff": [
{
"_links": {
"self": {
"href": "/staff[/:staff_id]"
}
}
"nome": "",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"estado": "",
"cep": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": ""
}
]
}
}
POST /staff
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cnpj | YES | ||
| inscricao | NO | ||
| logradouro | YES | ||
| numero | YES | ||
| complemento | NO | ||
| bairro | YES | ||
| cidade | YES | ||
| estado | YES | ||
| cep | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| categoria_staff | YES | ||
| evento_staff | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"estado": "",
"cep": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/staff[/:staff_id]"
}
}
"nome": "",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"estado": "",
"cep": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": ""
}
GET /staff[/:staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cnpj | YES | ||
| inscricao | NO | ||
| logradouro | YES | ||
| numero | YES | ||
| complemento | NO | ||
| bairro | YES | ||
| cidade | YES | ||
| estado | YES | ||
| cep | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| categoria_staff | YES | ||
| evento_staff | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/staff[/:staff_id]"
}
}
"nome": "",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"estado": "",
"cep": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": ""
}
PATCH /staff[/:staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cnpj | YES | ||
| inscricao | NO | ||
| logradouro | YES | ||
| numero | YES | ||
| complemento | NO | ||
| bairro | YES | ||
| cidade | YES | ||
| estado | YES | ||
| cep | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| categoria_staff | YES | ||
| evento_staff | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /staff[/:staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cnpj | YES | ||
| inscricao | NO | ||
| logradouro | YES | ||
| numero | YES | ||
| complemento | NO | ||
| bairro | YES | ||
| cidade | YES | ||
| estado | YES | ||
| cep | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| categoria_staff | YES | ||
| evento_staff | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"estado": "",
"cep": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/staff[/:staff_id]"
}
}
"nome": "",
"cnpj": "",
"inscricao": "",
"logradouro": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"estado": "",
"cep": "",
"data_inc": "",
"user_inc": "",
"data_upd": "",
"user_upd": ""
}
DELETE /staff[/:staff_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| cnpj | YES | ||
| inscricao | NO | ||
| logradouro | YES | ||
| numero | YES | ||
| complemento | NO | ||
| bairro | YES | ||
| cidade | YES | ||
| estado | YES | ||
| cep | YES | ||
| data_inc | YES | ||
| user_inc | YES | ||
| data_upd | YES | ||
| user_upd | YES | ||
| categoria_staff | YES | ||
| evento_staff | YES | ||
| cliente | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Template
GET /template
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| text | YES | ||
| remetente | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /template
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| text | YES | ||
| remetente | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /template[/:template_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| text | YES | ||
| remetente | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /template[/:template_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| text | YES | ||
| remetente | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /template[/:template_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| text | YES | ||
| remetente | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /template[/:template_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| text | YES | ||
| remetente | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
TermoMontadora
Termo de responsabilidade da montadora
GET /termomontadora
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| fone | YES | ||
| celular | YES | ||
| cpf | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/termomontadora"
},
"first": {
"href": "/termomontadora?page={page}"
},
"prev": {
"href": "/termomontadora?page={page}"
},
"next": {
"href": "/termomontadora?page={page}"
},
"last": {
"href": "/termomontadora?page={page}"
}
}
"_embedded": {
"termo_montadora": [
{
"_links": {
"self": {
"href": "/termomontadora[/:termo_montadora_id]"
}
}
"nome": "",
"fone": "",
"celular": "",
"cpf": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
]
}
}
POST /termomontadora
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| fone | YES | ||
| celular | YES | ||
| cpf | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"fone": "",
"celular": "",
"cpf": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/termomontadora[/:termo_montadora_id]"
}
}
"nome": "",
"fone": "",
"celular": "",
"cpf": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
GET /termomontadora[/:termo_montadora_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| fone | YES | ||
| celular | YES | ||
| cpf | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/termomontadora[/:termo_montadora_id]"
}
}
"nome": "",
"fone": "",
"celular": "",
"cpf": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
PATCH /termomontadora[/:termo_montadora_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| fone | YES | ||
| celular | YES | ||
| cpf | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"fone": "",
"celular": "",
"cpf": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/termomontadora[/:termo_montadora_id]"
}
}
"nome": "",
"fone": "",
"celular": "",
"cpf": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
PUT /termomontadora[/:termo_montadora_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| fone | YES | ||
| celular | YES | ||
| cpf | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"fone": "",
"celular": "",
"cpf": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/termomontadora[/:termo_montadora_id]"
}
}
"nome": "",
"fone": "",
"celular": "",
"cpf": "",
"user_inc": "",
"data_inc": "",
"user_upd": "",
"data_upd": "",
"pedido": ""
}
DELETE /termomontadora[/:termo_montadora_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| fone | YES | ||
| celular | YES | ||
| cpf | YES | ||
| user_inc | YES | ||
| data_inc | YES | ||
| user_upd | YES | ||
| data_upd | YES | ||
| pedido | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
TipoArquivoPedido
Categoria de arquivo a serem enviados a promotora do evento
GET /tipoarquivopedido
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tipoarquivopedido"
},
"first": {
"href": "/tipoarquivopedido?page={page}"
},
"prev": {
"href": "/tipoarquivopedido?page={page}"
},
"next": {
"href": "/tipoarquivopedido?page={page}"
},
"last": {
"href": "/tipoarquivopedido?page={page}"
}
}
"_embedded": {
"tipo_arquivo_pedido": [
{
"_links": {
"self": {
"href": "/tipoarquivopedido[/:tipo_arquivo_pedido_id]"
}
}
"nome": ""
}
]
}
}
POST /tipoarquivopedido
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tipoarquivopedido[/:tipo_arquivo_pedido_id]"
}
}
"nome": ""
}
GET /tipoarquivopedido[/:tipo_arquivo_pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /tipoarquivopedido[/:tipo_arquivo_pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /tipoarquivopedido[/:tipo_arquivo_pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /tipoarquivopedido[/:tipo_arquivo_pedido_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
TipoCliente
Tipo de cliente
GET /tipocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tipocliente"
},
"first": {
"href": "/tipocliente?page={page}"
},
"prev": {
"href": "/tipocliente?page={page}"
},
"next": {
"href": "/tipocliente?page={page}"
},
"last": {
"href": "/tipocliente?page={page}"
}
}
"_embedded": {
"tipo_cliente": [
{
"_links": {
"self": {
"href": "/tipocliente[/:tipo_cliente_id]"
}
}
"nome": ""
}
]
}
}
POST /tipocliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /tipocliente[/:tipo_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tipocliente[/:tipo_cliente_id]"
}
}
"nome": ""
}
PATCH /tipocliente[/:tipo_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /tipocliente[/:tipo_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tipocliente[/:tipo_cliente_id]"
}
}
"nome": ""
}
DELETE /tipocliente[/:tipo_cliente_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
TipoDocumento
GET /tipodocumento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tipodocumento"
},
"first": {
"href": "/tipodocumento?page={page}"
},
"prev": {
"href": "/tipodocumento?page={page}"
},
"next": {
"href": "/tipodocumento?page={page}"
},
"last": {
"href": "/tipodocumento?page={page}"
}
}
"_embedded": {
"tipo_documento": [
{
"_links": {
"self": {
"href": "/tipodocumento[/:tipo_documento_id]"
}
}
"nome": ""
}
]
}
}
POST /tipodocumento
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tipodocumento[/:tipo_documento_id]"
}
}
"nome": ""
}
GET /tipodocumento[/:tipo_documento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tipodocumento[/:tipo_documento_id]"
}
}
"nome": ""
}
PATCH /tipodocumento[/:tipo_documento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /tipodocumento[/:tipo_documento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tipodocumento[/:tipo_documento_id]"
}
}
"nome": ""
}
DELETE /tipodocumento[/:tipo_documento_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
TipoRecibo
GET /tiporecibo
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tiporecibo"
},
"first": {
"href": "/tiporecibo?page={page}"
},
"prev": {
"href": "/tiporecibo?page={page}"
},
"next": {
"href": "/tiporecibo?page={page}"
},
"last": {
"href": "/tiporecibo?page={page}"
}
}
"_embedded": {
"tipo_recibo": [
{
"_links": {
"self": {
"href": "/tiporecibo[/:tipo_recibo_id]"
}
}
"nome": ""
}
]
}
}
POST /tiporecibo
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tiporecibo[/:tipo_recibo_id]"
}
}
"nome": ""
}
GET /tiporecibo[/:tipo_recibo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tiporecibo[/:tipo_recibo_id]"
}
}
"nome": ""
}
PATCH /tiporecibo[/:tipo_recibo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /tiporecibo[/:tipo_recibo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
Body
{
"nome": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/tiporecibo[/:tipo_recibo_id]"
}
}
"nome": ""
}
DELETE /tiporecibo[/:tipo_recibo_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
TipoTemplate
GET /tipotemplate
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /tipotemplate
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /tipotemplate[/:tipo_template_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /tipotemplate[/:tipo_template_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /tipotemplate[/:tipo_template_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /tipotemplate[/:tipo_template_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Usuario
CRUD Usuários
GET /usuario
Lista de usuários https://api.alweb.com.br/usuario
Usuário único https://api.alweb.com.br/usuario/id_do_cliente
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| senha | password | YES | |
| cliente_id | YES | ||
| perfil_id | YES | ||
| status | text | YES | |
| user_inc | text | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | YES | ||
| image | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/usuario"
},
"first": {
"href": "/usuario?page={page}"
},
"prev": {
"href": "/usuario?page={page}"
},
"next": {
"href": "/usuario?page={page}"
},
"last": {
"href": "/usuario?page={page}"
}
}
"_embedded": {
"usuario": [
{
"_links": {
"self": {
"href": "/usuario[/:usuario_id]"
}
}
"nome": "",
"email": "",
"senha": "",
"perfilId": "",
"clienteId": ""
}
]
}
}
POST /usuario
Inserir https://api.alweb.com.br/usuario
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| senha | password | YES | |
| cliente_id | YES | ||
| perfil_id | YES | ||
| status | text | YES | |
| user_inc | text | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | YES | ||
| image | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"email": "",
"senha": "",
"perfilId": "",
"clienteId": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/usuario[/:usuario_id]"
}
}
"nome": "",
"email": "",
"senha": "",
"perfilId": "",
"clienteId": ""
}
GET /usuario[/:usuario_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| senha | password | YES | |
| cliente_id | YES | ||
| perfil_id | YES | ||
| status | text | YES | |
| user_inc | text | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | YES | ||
| image | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/usuario[/:usuario_id]"
}
}
"nome": "",
"email": "",
"senha": "",
"perfilId": "",
"clienteId": ""
}
PATCH /usuario[/:usuario_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| senha | password | YES | |
| cliente_id | YES | ||
| perfil_id | YES | ||
| status | text | YES | |
| user_inc | text | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | YES | ||
| image | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"email": "",
"senha": "",
"perfilId": "",
"clienteId": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/usuario[/:usuario_id]"
}
}
"nome": "",
"email": "",
"senha": "",
"perfilId": "",
"clienteId": ""
}
PUT /usuario[/:usuario_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| senha | password | YES | |
| cliente_id | YES | ||
| perfil_id | YES | ||
| status | text | YES | |
| user_inc | text | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | YES | ||
| image | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.safe.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"nome": "",
"email": "",
"senha": "",
"perfilId": "",
"clienteId": ""
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/usuario[/:usuario_id]"
}
}
"nome": "",
"email": "",
"senha": "",
"perfilId": "",
"clienteId": ""
}
DELETE /usuario[/:usuario_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| nome | YES | ||
| YES | |||
| senha | password | YES | |
| cliente_id | YES | ||
| perfil_id | YES | ||
| status | text | YES | |
| user_inc | text | YES | |
| data_inc | text | YES | |
| user_upd | text | YES | |
| data_upd | YES | ||
| image | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.safe.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.safe.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |