POST api/User
Agrega un usuario y lo asigna a la empresa indicada
Request Information
URI Parameters
None.
Body Parameters
Layout para la generación de usuarios
UserModelApiName | Description | Type | Additional information |
---|---|---|---|
Correo electrónico |
string |
Required |
|
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. |
Password |
Contraseña del usuario |
string |
None. |
Role |
Perfil del usuario |
RoleApi |
Required |
GrantorTaxId |
Identificador único de la empresa |
string |
Required Matching regular expression pattern: ^[A-Z&Ñ]{3,4}[0-9]{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])[A-Z0-9]{2}[0-9A]$ Max length: 13 Min length: 12 |
ExternalUserId |
Identificador del usuario en sistemas externos a la plataforma usado para SSO |
string |
Required Max length: 36 |
IsSeller |
El usuario es vendedor |
boolean |
None. |
Branchs |
Sucursales a las que pertenece el vendedor, si no se indica ninguna se asume que ve todas |
Collection of string |
None. |
Code | string |
None. |
Request Formats
application/json, text/json
{ "Email": "sample string 1", "Name1": "sample string 2", "Name2": "sample string 3", "Surname1": "sample string 4", "Surname2": "sample string 5", "Cellphone": "sample string 6", "Phone": "sample string 7", "Password": "sample string 8", "Role": 0, "GrantorTaxId": "sample string 9", "ExternalUserId": "sample string 10", "IsSeller": true, "Branchs": [ "sample string 1", "sample string 2" ], "Code": "sample string 12" }
application/xml, text/xml
<UserModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Email>sample string 1</Email> <Name1>sample string 2</Name1> <Name2>sample string 3</Name2> <Surname1>sample string 4</Surname1> <Surname2>sample string 5</Surname2> <Cellphone>sample string 6</Cellphone> <Phone>sample string 7</Phone> <Password>sample string 8</Password> <Role>Other</Role> <GrantorTaxId>sample string 9</GrantorTaxId> <ExternalUserId>sample string 10</ExternalUserId> <IsSeller>true</IsSeller> <Branchs> <string>sample string 1</string> <string>sample string 2</string> </Branchs> <Code>sample string 12</Code> </UserModelApi>
application/x-www-form-urlencoded
Response Information
Resource Description
Layout con el idntificador único del usuario creado
ResponseModelApiOfUserCreatedResponseModelApiName | Description | Type | Additional 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 |
UserCreatedResponseModelApi |
None. |
Response Formats
application/json, text/json
{ "success": true, "message": "sample string 2", "messageDetail": [ "sample string 1", "sample string 2" ], "failureCode": "sample string 3", "data": { "UserId": "08dd2e4d-45d7-1216-522b-6e3108c3f9a1" } }
application/xml, text/xml
<ResponseModelApiOfUserCreatedResponseModelApi 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>08dd2e4d-45d7-1216-522b-6e3108c3f9a1</UserId> </data> </ResponseModelApiOfUserCreatedResponseModelApi>