POST api/Auth/1/1/GetUserData

Obtener información adicional de usuario durante una sesión abierta usando etiquetas


Información del Request

Parametros de la URI

No posee parametros

Parametros del Body

SFE.Auth.Core.Requests.GetUserDataRequest
NombreDescripciónTipoInformación Adicional
tags

Etiquetas de información de usuario

Collection of string

N/A

allowEmptyData

Indica si se permiten etiquetas sin datos o se genera error

boolean

N/A

session

Información de sesión

SFE.Core.Models.AUTH.SessionCredential

N/A

applicationId

Identificador de la aplicación que consume el API. Valor constante acordado con el cliente

string

N/A

applicationVersion

Identificador de la versión de la aplicación

string

Max length: 100

applicationOS

Identificador del sistema operativo de la aplicación (en mayúsculas) Ejemplo: ANDROID, IOS

string

Max length: 100

language

Código ISO 639-1 de dos letras del idioma usado para los mensajes

string

Max length: 5

deviceId

Identificador del dispositivo registrado

integer

N/A

deviceAltId

Identificador alternativo del dispositivo registrado

string

Max length: 128

ipAddress

Dirección IP pública del dispositivo

string

Matching regular expression pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

latitude

Latitud dela ubicación enviada por dispositivo

string

Max length: 50

longitude

Longitud dela ubicación enviada por dispositivo

string

Max length: 50

additionalParameters

Datos adicionales

Dictionary of string [key] and string [value]

N/A

Ejemplos de request:

application/json, text/json

Ejemplo:
{
  "tags": [
    "sample string 1",
    "sample string 2"
  ],
  "allowEmptyData": true,
  "session": {
    "userId": 1,
    "userAltId": "sample string 2",
    "sessionId": 3,
    "sessionAltId": "sample string 4"
  },
  "applicationId": "sample string 2",
  "applicationVersion": "sample string 3",
  "applicationOS": "sample string 4",
  "language": "sample string 5",
  "deviceId": 6,
  "deviceAltId": "sample string 7",
  "ipAddress": "sample string 8",
  "latitude": "sample string 9",
  "longitude": "sample string 10",
  "additionalParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Ejemplo:
<GetUserDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">
  <additionalParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </additionalParameters>
  <applicationId>sample string 2</applicationId>
  <applicationOS>sample string 4</applicationOS>
  <applicationVersion>sample string 3</applicationVersion>
  <deviceAltId>sample string 7</deviceAltId>
  <deviceId>6</deviceId>
  <ipAddress>sample string 8</ipAddress>
  <language>sample string 5</language>
  <latitude>sample string 9</latitude>
  <longitude>sample string 10</longitude>
  <allowEmptyData>true</allowEmptyData>
  <session xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFE.Core.Models.AUTH">
    <d2p1:sessionAltId>sample string 4</d2p1:sessionAltId>
    <d2p1:sessionId>3</d2p1:sessionId>
    <d2p1:userAltId>sample string 2</d2p1:userAltId>
    <d2p1:userId>1</d2p1:userId>
  </session>
  <tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </tags>
</GetUserDataRequest>

Información del Response

Descripción de los parametros

KinPOS.API.GenericResultOfSFE.Auth.Core.Requests.GetUserDataResponse
NombreDescripciónTipoInformación Adicional
encryptedData

string

N/A

response

SFE.Auth.Core.Requests.GetUserDataResponse

N/A

Ejemplos de response:

application/json, text/json

Ejemplo:
{
  "encryptedData": "sample string 1"
}

application/xml

Ejemplo:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'SFE.Auth.Core.Requests.GetUserDataResponse' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Ejemplo:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'SFE.Auth.Core.Requests.GetUserDataResponse' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.