POST api/v2/endereco/inserir

Request Information

URI Parameters

None.

Body Parameters

InserirEnderecoBindingModel
NameDescriptionTypeAdditional information
TenantId

globally unique identifier

Required

EntityCanalId

string

None.

PedidoId

integer

Required

CanalId

integer

Required

Endereco

string

Required

Cidade

string

Required

Estado

string

Required

Cep

string

Required

Numero

string

Required

Bairro

string

Required

Complemento

string

None.

Request Formats

application/json, text/json

Sample:
{
  "TenantId": "d899a1fd-12c3-4d6a-abf3-8f57d2b5df1a",
  "EntityCanalId": "sample string 2",
  "PedidoId": 3,
  "CanalId": 4,
  "Endereco": "sample string 5",
  "Cidade": "sample string 6",
  "Estado": "sample string 7",
  "Cep": "sample string 8",
  "Numero": "sample string 9",
  "Bairro": "sample string 10",
  "Complemento": "sample string 11"
}

application/xml, text/xml

Sample:
<InserirEnderecoBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models.v2.BindingModels">
  <Bairro>sample string 10</Bairro>
  <CanalId>4</CanalId>
  <Cep>sample string 8</Cep>
  <Cidade>sample string 6</Cidade>
  <Complemento>sample string 11</Complemento>
  <Endereco>sample string 5</Endereco>
  <EntityCanalId>sample string 2</EntityCanalId>
  <Estado>sample string 7</Estado>
  <Numero>sample string 9</Numero>
  <PedidoId>3</PedidoId>
  <TenantId>d899a1fd-12c3-4d6a-abf3-8f57d2b5df1a</TenantId>
</InserirEnderecoBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UpdateEnderecoResult
NameDescriptionTypeAdditional information
EnderecoId

integer

None.

Succeeded

boolean

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "EnderecoId": 1,
  "Succeeded": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<UpdateEnderecoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FormulaCertaAPI.Models">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Succeeded>true</Succeeded>
  <EnderecoId>1</EnderecoId>
</UpdateEnderecoResult>