POST api/Auth/1/1/GetTacDocument

Obtener documento de contrato personalizado

Información del Request

Parametros de la URI

No posee parametros

Parametros del Body

Objeto que contiene los parámetros de la petición

SFE.Auth.Core.Requests.GetTacDocumentRequest

Nombre	Descripción	Tipo	Información Adicional
userAltId	Identificador de usuario	string	N/A
documentTag	Etiqueta del documento a solicitar	string	N/A
generatePdf	Indica si se genera un archivo PDF en lugar de texto HTML	boolean	N/A
userRegistrationStepId	Identificador del paso de registro de usuario. Debe estar registrado en la tabla de pasos de registro de usuario	integer	N/A
fieldName	Nombre del campo asociado al usuario donde se guardará el documento generado	string	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:

{
  "userAltId": "sample string 1",
  "documentTag": "sample string 2",
  "generatePdf": true,
  "userRegistrationStepId": 4,
  "fieldName": "sample string 5",
  "applicationId": "sample string 6",
  "applicationVersion": "sample string 7",
  "applicationOS": "sample string 8",
  "language": "sample string 9",
  "deviceId": 10,
  "deviceAltId": "sample string 11",
  "ipAddress": "sample string 12",
  "latitude": "sample string 13",
  "longitude": "sample string 14",
  "additionalParameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Ejemplo:

<GetTacDocumentRequest 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 6</applicationId>
  <applicationOS>sample string 8</applicationOS>
  <applicationVersion>sample string 7</applicationVersion>
  <deviceAltId>sample string 11</deviceAltId>
  <deviceId>10</deviceId>
  <ipAddress>sample string 12</ipAddress>
  <language>sample string 9</language>
  <latitude>sample string 13</latitude>
  <longitude>sample string 14</longitude>
  <documentTag>sample string 2</documentTag>
  <fieldName>sample string 5</fieldName>
  <generatePdf>true</generatePdf>
  <userAltId>sample string 1</userAltId>
  <userRegistrationStepId>4</userRegistrationStepId>
</GetTacDocumentRequest>

Información del Response

Descripción de los parametros

KinPOS.API.GenericResultOfSFE.Auth.Core.Requests.GetTacDocumentResponse

Nombre	Descripción	Tipo	Información Adicional
encryptedData		string	N/A
response		SFE.Auth.Core.Requests.GetTacDocumentResponse	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.GetTacDocumentResponse' 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.GetTacDocumentResponse' 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.