POST api/Clientes
Request Information
URI Parameters
None.
Body Parameters
CLIENTES| Name | Description | Type | Additional information |
|---|---|---|---|
| CNPJ | string |
String length: inclusive between 0 and 14 |
|
| RAZ_SOC | string |
String length: inclusive between 0 and 65 |
|
| VERSAO_ATUAL | string |
String length: inclusive between 0 and 20 |
|
| SERVICE_PACK | string |
String length: inclusive between 0 and 2 |
|
| VERSAO_EXPRESS | string |
String length: inclusive between 0 and 20 |
|
| NM_APELIDO | string |
String length: inclusive between 0 and 65 |
|
| TIPO_DB | string |
String length: inclusive between 0 and 30 |
|
| DATA_EXE | date |
None. |
|
| ID_CIDADE | integer |
None. |
|
| NOVO | integer |
None. |
|
| TIPO_DOCUMENTO | integer |
None. |
|
| TELEFONE | string |
String length: inclusive between 0 and 14 |
|
| CONTATO | string |
String length: inclusive between 0 and 30 |
|
| DATA_INSTALACAO | date |
None. |
|
| string |
String length: inclusive between 0 and 80 |
||
| MENSAGENS | Collection of ALPHA_EXPRESS_MENSAGENS |
None. |
|
| DB_VERSION | string |
String length: inclusive between 0 and 60 |
|
| DB_NAME | string |
String length: inclusive between 0 and 60 |
|
| DB_EDITION | string |
String length: inclusive between 0 and 60 |
Request Formats
application/json, text/json
{
"CNPJ": "sample string 1",
"RAZ_SOC": "sample string 2",
"VERSAO_ATUAL": "sample string 3",
"SERVICE_PACK": "sample string 4",
"VERSAO_EXPRESS": "sample string 5",
"NM_APELIDO": "sample string 6",
"TIPO_DB": "sample string 7",
"DATA_EXE": "2025-12-30T21:48:29.4340904-08:00",
"ID_CIDADE": 1,
"NOVO": 1,
"TIPO_DOCUMENTO": 1,
"TELEFONE": "sample string 8",
"CONTATO": "sample string 9",
"DATA_INSTALACAO": "2025-12-30T21:48:29.4350917-08:00",
"EMAIL": "sample string 10",
"MENSAGENS": [],
"DB_VERSION": "sample string 11",
"DB_NAME": "sample string 12",
"DB_EDITION": "sample string 13"
}
application/xml, text/xml
<CLIENTES xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlphaSoftwareAPI.Models"> <CNPJ>sample string 1</CNPJ> <CONTATO>sample string 9</CONTATO> <DATA_EXE>2025-12-30T21:48:29.4340904-08:00</DATA_EXE> <DATA_INSTALACAO>2025-12-30T21:48:29.4350917-08:00</DATA_INSTALACAO> <DB_EDITION>sample string 13</DB_EDITION> <DB_NAME>sample string 12</DB_NAME> <DB_VERSION>sample string 11</DB_VERSION> <EMAIL>sample string 10</EMAIL> <ID_CIDADE>1</ID_CIDADE> <MENSAGENS /> <NM_APELIDO>sample string 6</NM_APELIDO> <NOVO>1</NOVO> <RAZ_SOC>sample string 2</RAZ_SOC> <SERVICE_PACK>sample string 4</SERVICE_PACK> <TELEFONE>sample string 8</TELEFONE> <TIPO_DB>sample string 7</TIPO_DB> <TIPO_DOCUMENTO>1</TIPO_DOCUMENTO> <VERSAO_ATUAL>sample string 3</VERSAO_ATUAL> <VERSAO_EXPRESS>sample string 5</VERSAO_EXPRESS> </CLIENTES>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
CLIENTES| Name | Description | Type | Additional information |
|---|---|---|---|
| CNPJ | string |
String length: inclusive between 0 and 14 |
|
| RAZ_SOC | string |
String length: inclusive between 0 and 65 |
|
| VERSAO_ATUAL | string |
String length: inclusive between 0 and 20 |
|
| SERVICE_PACK | string |
String length: inclusive between 0 and 2 |
|
| VERSAO_EXPRESS | string |
String length: inclusive between 0 and 20 |
|
| NM_APELIDO | string |
String length: inclusive between 0 and 65 |
|
| TIPO_DB | string |
String length: inclusive between 0 and 30 |
|
| DATA_EXE | date |
None. |
|
| ID_CIDADE | integer |
None. |
|
| NOVO | integer |
None. |
|
| TIPO_DOCUMENTO | integer |
None. |
|
| TELEFONE | string |
String length: inclusive between 0 and 14 |
|
| CONTATO | string |
String length: inclusive between 0 and 30 |
|
| DATA_INSTALACAO | date |
None. |
|
| string |
String length: inclusive between 0 and 80 |
||
| MENSAGENS | Collection of ALPHA_EXPRESS_MENSAGENS |
None. |
|
| DB_VERSION | string |
String length: inclusive between 0 and 60 |
|
| DB_NAME | string |
String length: inclusive between 0 and 60 |
|
| DB_EDITION | string |
String length: inclusive between 0 and 60 |
Response Formats
application/json, text/json
{
"CNPJ": "sample string 1",
"RAZ_SOC": "sample string 2",
"VERSAO_ATUAL": "sample string 3",
"SERVICE_PACK": "sample string 4",
"VERSAO_EXPRESS": "sample string 5",
"NM_APELIDO": "sample string 6",
"TIPO_DB": "sample string 7",
"DATA_EXE": "2025-12-30T21:48:29.4670906-08:00",
"ID_CIDADE": 1,
"NOVO": 1,
"TIPO_DOCUMENTO": 1,
"TELEFONE": "sample string 8",
"CONTATO": "sample string 9",
"DATA_INSTALACAO": "2025-12-30T21:48:29.4670906-08:00",
"EMAIL": "sample string 10",
"MENSAGENS": [],
"DB_VERSION": "sample string 11",
"DB_NAME": "sample string 12",
"DB_EDITION": "sample string 13"
}
application/xml, text/xml
<CLIENTES xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlphaSoftwareAPI.Models"> <CNPJ>sample string 1</CNPJ> <CONTATO>sample string 9</CONTATO> <DATA_EXE>2025-12-30T21:48:29.4670906-08:00</DATA_EXE> <DATA_INSTALACAO>2025-12-30T21:48:29.4670906-08:00</DATA_INSTALACAO> <DB_EDITION>sample string 13</DB_EDITION> <DB_NAME>sample string 12</DB_NAME> <DB_VERSION>sample string 11</DB_VERSION> <EMAIL>sample string 10</EMAIL> <ID_CIDADE>1</ID_CIDADE> <MENSAGENS /> <NM_APELIDO>sample string 6</NM_APELIDO> <NOVO>1</NOVO> <RAZ_SOC>sample string 2</RAZ_SOC> <SERVICE_PACK>sample string 4</SERVICE_PACK> <TELEFONE>sample string 8</TELEFONE> <TIPO_DB>sample string 7</TIPO_DB> <TIPO_DOCUMENTO>1</TIPO_DOCUMENTO> <VERSAO_ATUAL>sample string 3</VERSAO_ATUAL> <VERSAO_EXPRESS>sample string 5</VERSAO_EXPRESS> </CLIENTES>