POST api/Auth/1/1/username

Registrar username

Información del Request

Parametros de la URI

No posee parametros

Parametros del Body

KinPOS.API.Controllers.AUTH.FidoUsernameRequest
NombreDescripciónTipoInformación Adicional
username

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: 
{
  "username": "sample string 1",
  "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: 
<FidoUsernameRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KinPOS.API.Controllers.AUTH">
  <additionalParameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">
    <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 xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 2</applicationId>
  <applicationOS xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 4</applicationOS>
  <applicationVersion xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 3</applicationVersion>
  <deviceAltId xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 7</deviceAltId>
  <deviceId xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">6</deviceId>
  <ipAddress xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 8</ipAddress>
  <language xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 5</language>
  <latitude xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 9</latitude>
  <longitude xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 10</longitude>
  <username>sample string 1</username>
</FidoUsernameRequest>

Información del Response

Descripción de los parametros

KinPOS.API.Controllers.AUTH.FidoUsernameResponse
NombreDescripciónTipoInformación Adicional
sessionId

string

N/A
result

Resultado del proceso

 SFE.Shared.TextUtils.ProcessResult

N/A
additionalData

Información producida por el postproceso de esta peticíón Ejemplos: cmsAccountId Identificador de la cuenta CMS (cuenta virtual), en caso de que se haya creado una cmsProgramId Identificador del programa CMS al que va asociada a la cuenta CMS creada

 Dictionary of string [key] and string [value]

N/A
NextStepFields

Collection of SFE.Auth.Plugin.Shared.Model.StepField

N/A
nextStepName

Orden del paso siguiente de registro

 string

N/A
nextStepId

Id del paso siguiente de registro

 integer

N/A
nextStepOrder

Orden del paso siguiente de registro

 integer

N/A
PreviousStepFields

Collection of SFE.Auth.Plugin.Shared.Model.StepField

N/A
PreviousStepName

string

N/A
PreviousStepId

integer

N/A
PreviousStepOrder

integer

N/A
stopCode

Código de detención, solo en caso de que el proceso deba detenerse.

 SFE.Auth.Core.Model.EnumStopCode

N/A

Ejemplos de response:

application/json, text/json

Ejemplo: 
{
  "sessionId": "sample string 1",
  "result": {
    "Message": "sample string 1",
    "Code": 2,
    "IsOk": true,
    "IsErrorSet": true,
    "LogFails": false
  },
  "additionalData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "NextStepFields": [
    {
      "FieldName": "sample string 1",
      "FieldTypeId": 1,
      "ControlId": 0,
      "CustomControlName": "sample string 2",
      "Enabled": true,
      "Required": true,
      "MaxLength": 5,
      "MinLength": 6,
      "MinValue": "sample string 7",
      "MaxValue": "sample string 8",
      "ValidationRegex": "sample string 9",
      "InputMask": "sample string 10",
      "MaskFilters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "Label": "sample string 11",
      "Hint": "sample string 12",
      "DefaultValue": "sample string 13",
      "ToLower": true,
      "ToUpper": true,
      "HiddenEntry": true,
      "HaveConfirmation": true,
      "Interval": 18.1,
      "ComboFilterField": "sample string 19"
    },
    {
      "FieldName": "sample string 1",
      "FieldTypeId": 1,
      "ControlId": 0,
      "CustomControlName": "sample string 2",
      "Enabled": true,
      "Required": true,
      "MaxLength": 5,
      "MinLength": 6,
      "MinValue": "sample string 7",
      "MaxValue": "sample string 8",
      "ValidationRegex": "sample string 9",
      "InputMask": "sample string 10",
      "MaskFilters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "Label": "sample string 11",
      "Hint": "sample string 12",
      "DefaultValue": "sample string 13",
      "ToLower": true,
      "ToUpper": true,
      "HiddenEntry": true,
      "HaveConfirmation": true,
      "Interval": 18.1,
      "ComboFilterField": "sample string 19"
    }
  ],
  "nextStepName": "sample string 2",
  "nextStepId": 3,
  "nextStepOrder": 4,
  "PreviousStepFields": [
    {
      "FieldName": "sample string 1",
      "FieldTypeId": 1,
      "ControlId": 0,
      "CustomControlName": "sample string 2",
      "Enabled": true,
      "Required": true,
      "MaxLength": 5,
      "MinLength": 6,
      "MinValue": "sample string 7",
      "MaxValue": "sample string 8",
      "ValidationRegex": "sample string 9",
      "InputMask": "sample string 10",
      "MaskFilters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "Label": "sample string 11",
      "Hint": "sample string 12",
      "DefaultValue": "sample string 13",
      "ToLower": true,
      "ToUpper": true,
      "HiddenEntry": true,
      "HaveConfirmation": true,
      "Interval": 18.1,
      "ComboFilterField": "sample string 19"
    },
    {
      "FieldName": "sample string 1",
      "FieldTypeId": 1,
      "ControlId": 0,
      "CustomControlName": "sample string 2",
      "Enabled": true,
      "Required": true,
      "MaxLength": 5,
      "MinLength": 6,
      "MinValue": "sample string 7",
      "MaxValue": "sample string 8",
      "ValidationRegex": "sample string 9",
      "InputMask": "sample string 10",
      "MaskFilters": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "Label": "sample string 11",
      "Hint": "sample string 12",
      "DefaultValue": "sample string 13",
      "ToLower": true,
      "ToUpper": true,
      "HiddenEntry": true,
      "HaveConfirmation": true,
      "Interval": 18.1,
      "ComboFilterField": "sample string 19"
    }
  ],
  "PreviousStepName": "sample string 5",
  "PreviousStepId": 6,
  "PreviousStepOrder": 7,
  "stopCode": 0
}

application/xml, text/xml

Ejemplo: 
<FidoUsernameResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KinPOS.API.Controllers.AUTH">
  <NextStepFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFE.Auth.Plugin.Shared.Model" xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">
    <d2p1:StepField>
      <d2p1:ComboFilterField>sample string 19</d2p1:ComboFilterField>
      <d2p1:ControlId>UNDEFINED</d2p1:ControlId>
      <d2p1:CustomControlName>sample string 2</d2p1:CustomControlName>
      <d2p1:DefaultValue>sample string 13</d2p1:DefaultValue>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:FieldName>sample string 1</d2p1:FieldName>
      <d2p1:FieldTypeId>INT_NUMBER</d2p1:FieldTypeId>
      <d2p1:HaveConfirmation>true</d2p1:HaveConfirmation>
      <d2p1:HiddenEntry>true</d2p1:HiddenEntry>
      <d2p1:Hint>sample string 12</d2p1:Hint>
      <d2p1:InputMask>sample string 10</d2p1:InputMask>
      <d2p1:Interval>18.1</d2p1:Interval>
      <d2p1:Label>sample string 11</d2p1:Label>
      <d2p1:MaskFilters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:MaskFilters>
      <d2p1:MaxLength>5</d2p1:MaxLength>
      <d2p1:MaxValue>sample string 8</d2p1:MaxValue>
      <d2p1:MinLength>6</d2p1:MinLength>
      <d2p1:MinValue>sample string 7</d2p1:MinValue>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:ToLower>true</d2p1:ToLower>
      <d2p1:ToUpper>true</d2p1:ToUpper>
      <d2p1:ValidationRegex>sample string 9</d2p1:ValidationRegex>
    </d2p1:StepField>
    <d2p1:StepField>
      <d2p1:ComboFilterField>sample string 19</d2p1:ComboFilterField>
      <d2p1:ControlId>UNDEFINED</d2p1:ControlId>
      <d2p1:CustomControlName>sample string 2</d2p1:CustomControlName>
      <d2p1:DefaultValue>sample string 13</d2p1:DefaultValue>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:FieldName>sample string 1</d2p1:FieldName>
      <d2p1:FieldTypeId>INT_NUMBER</d2p1:FieldTypeId>
      <d2p1:HaveConfirmation>true</d2p1:HaveConfirmation>
      <d2p1:HiddenEntry>true</d2p1:HiddenEntry>
      <d2p1:Hint>sample string 12</d2p1:Hint>
      <d2p1:InputMask>sample string 10</d2p1:InputMask>
      <d2p1:Interval>18.1</d2p1:Interval>
      <d2p1:Label>sample string 11</d2p1:Label>
      <d2p1:MaskFilters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:MaskFilters>
      <d2p1:MaxLength>5</d2p1:MaxLength>
      <d2p1:MaxValue>sample string 8</d2p1:MaxValue>
      <d2p1:MinLength>6</d2p1:MinLength>
      <d2p1:MinValue>sample string 7</d2p1:MinValue>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:ToLower>true</d2p1:ToLower>
      <d2p1:ToUpper>true</d2p1:ToUpper>
      <d2p1:ValidationRegex>sample string 9</d2p1:ValidationRegex>
    </d2p1:StepField>
  </NextStepFields>
  <PreviousStepFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFE.Auth.Plugin.Shared.Model" xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">
    <d2p1:StepField>
      <d2p1:ComboFilterField>sample string 19</d2p1:ComboFilterField>
      <d2p1:ControlId>UNDEFINED</d2p1:ControlId>
      <d2p1:CustomControlName>sample string 2</d2p1:CustomControlName>
      <d2p1:DefaultValue>sample string 13</d2p1:DefaultValue>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:FieldName>sample string 1</d2p1:FieldName>
      <d2p1:FieldTypeId>INT_NUMBER</d2p1:FieldTypeId>
      <d2p1:HaveConfirmation>true</d2p1:HaveConfirmation>
      <d2p1:HiddenEntry>true</d2p1:HiddenEntry>
      <d2p1:Hint>sample string 12</d2p1:Hint>
      <d2p1:InputMask>sample string 10</d2p1:InputMask>
      <d2p1:Interval>18.1</d2p1:Interval>
      <d2p1:Label>sample string 11</d2p1:Label>
      <d2p1:MaskFilters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:MaskFilters>
      <d2p1:MaxLength>5</d2p1:MaxLength>
      <d2p1:MaxValue>sample string 8</d2p1:MaxValue>
      <d2p1:MinLength>6</d2p1:MinLength>
      <d2p1:MinValue>sample string 7</d2p1:MinValue>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:ToLower>true</d2p1:ToLower>
      <d2p1:ToUpper>true</d2p1:ToUpper>
      <d2p1:ValidationRegex>sample string 9</d2p1:ValidationRegex>
    </d2p1:StepField>
    <d2p1:StepField>
      <d2p1:ComboFilterField>sample string 19</d2p1:ComboFilterField>
      <d2p1:ControlId>UNDEFINED</d2p1:ControlId>
      <d2p1:CustomControlName>sample string 2</d2p1:CustomControlName>
      <d2p1:DefaultValue>sample string 13</d2p1:DefaultValue>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:FieldName>sample string 1</d2p1:FieldName>
      <d2p1:FieldTypeId>INT_NUMBER</d2p1:FieldTypeId>
      <d2p1:HaveConfirmation>true</d2p1:HaveConfirmation>
      <d2p1:HiddenEntry>true</d2p1:HiddenEntry>
      <d2p1:Hint>sample string 12</d2p1:Hint>
      <d2p1:InputMask>sample string 10</d2p1:InputMask>
      <d2p1:Interval>18.1</d2p1:Interval>
      <d2p1:Label>sample string 11</d2p1:Label>
      <d2p1:MaskFilters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:MaskFilters>
      <d2p1:MaxLength>5</d2p1:MaxLength>
      <d2p1:MaxValue>sample string 8</d2p1:MaxValue>
      <d2p1:MinLength>6</d2p1:MinLength>
      <d2p1:MinValue>sample string 7</d2p1:MinValue>
      <d2p1:Required>true</d2p1:Required>
      <d2p1:ToLower>true</d2p1:ToLower>
      <d2p1:ToUpper>true</d2p1:ToUpper>
      <d2p1:ValidationRegex>sample string 9</d2p1:ValidationRegex>
    </d2p1:StepField>
  </PreviousStepFields>
  <PreviousStepId xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">6</PreviousStepId>
  <PreviousStepName xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 5</PreviousStepName>
  <PreviousStepOrder xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">7</PreviousStepOrder>
  <additionalData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">
    <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>
  </additionalData>
  <nextStepId xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">3</nextStepId>
  <nextStepName xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">sample string 2</nextStepName>
  <nextStepOrder xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">4</nextStepOrder>
  <result xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFE.Shared.TextUtils" xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">
    <d2p1:Code>2</d2p1:Code>
    <d2p1:IsOk>true</d2p1:IsOk>
    <d2p1:Message>sample string 1</d2p1:Message>
  </result>
  <stopCode xmlns="http://schemas.datacontract.org/2004/07/SFE.Auth.Core.Requests">UNDEFINED</stopCode>
  <sessionId>sample string 1</sessionId>
</FidoUsernameResponse>