PUT api/User?Email={Email}

Actualizar usuario

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Email

Identificador del usuario (correo electrónico)

string

Required

Body Parameters

Layout para la actualización de usuarios

UserUpdateModelApi
NameDescriptionTypeAdditional information
Name1

Primer nombre

string

None.

Name2

Segundo nombre

string

None.

Surname1

Apellido 1

string

None.

Surname2

Apellido 2

string

None.

Cellphone

Teléfono celular, puede especificar solo el teléfono fijo (10 dígitos)

string

None.

Phone

Teléfono, puede especificar solo el teléfono celular (10 dígitos)

string

None.

ExternalUserId

Identificador del usuario en sistemas externos a la plataforma usado para SSO

string

Max length: 36

GrantorTaxId

Identificador único de la empresa

string

Required

Max length: 13

Min length: 12

Request Formats

application/json, text/json

Sample:
{
  "Name1": "sample string 1",
  "Name2": "sample string 2",
  "Surname1": "sample string 3",
  "Surname2": "sample string 4",
  "Cellphone": "sample string 5",
  "Phone": "sample string 6",
  "ExternalUserId": "sample string 7",
  "GrantorTaxId": "sample string 8"
}

application/xml, text/xml

Sample:
<UserUpdateModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name1>sample string 1</Name1>
  <Name2>sample string 2</Name2>
  <Surname1>sample string 3</Surname1>
  <Surname2>sample string 4</Surname2>
  <Cellphone>sample string 5</Cellphone>
  <Phone>sample string 6</Phone>
  <ExternalUserId>sample string 7</ExternalUserId>
  <GrantorTaxId>sample string 8</GrantorTaxId>
</UserUpdateModelApi>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserUpdateModelApi'.

Response Information

Resource Description

Layout con el idntificador único del usuario actualizado

ResponseModelApiOfUserUpdatedResponseModelApi
NameDescriptionTypeAdditional information
success

Indica si la solicitud se procesó de manera satisfactoria

boolean

None.

message

Mensaje de la solicitud

string

None.

messageDetail

Lista de mensajes

Collection of string

None.

failureCode

Código de error en caso de existir

string

None.

data

Layout de respuesta de la solicitud

UserUpdatedResponseModelApi

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "messageDetail": [
    "sample string 1",
    "sample string 2"
  ],
  "failureCode": "sample string 3",
  "data": {
    "UserId": "08dd2e47-b5b4-881b-522b-6e467c15cd52"
  }
}

application/xml, text/xml

Sample:
<ResponseModelApiOfUserUpdatedResponseModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <success>true</success>
  <message>sample string 2</message>
  <messageDetail>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </messageDetail>
  <failureCode>sample string 3</failureCode>
  <data>
    <UserId>08dd2e47-b5b4-881b-522b-6e467c15cd52</UserId>
  </data>
</ResponseModelApiOfUserUpdatedResponseModelApi>