POST Authentication/Login

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Email		string	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:

<RequestLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YourTicketAPI">
  <Email>sample string 1</Email>
  <Password>sample string 2</Password>
</RequestLogin>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseLogin

Name	Type	Additional information
Login2FAEnforce	boolean	None.
Login2FAAuthenticatorActivated	boolean	None.
JWTToken	string	None.
Message	string	None.
ScanText	string	None.
SettingsForApp	SettingsForApp	None.
success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Login2FAEnforce": true,
  "Login2FAAuthenticatorActivated": true,
  "JWTToken": "sample string 3",
  "Message": "sample string 4",
  "ScanText": "sample string 5",
  "SettingsForApp": {
    "FilesForApp": [
      {
        "Type": 0,
        "Url": "sample string 1",
        "Version": "sample string 2"
      },
      {
        "Type": 0,
        "Url": "sample string 1",
        "Version": "sample string 2"
      }
    ],
    "CameraPageScannerText": "sample string 1",
    "PopupShownFor": 2,
    "APIPopupMinimumShownFor": 3,
    "ScanTimeout": 4,
    "GuestOpenInformationPopupButtonText": "sample string 5",
    "GuestTitle": "sample string 6",
    "GuestSearchPlaceText": "sample string 7",
    "GuestDetailsAllEventsDropdownText": "sample string 8",
    "GuestDetailsAllEventsTitle": "sample string 9",
    "GuestDetailsAllEventsSubTitle": "sample string 10",
    "GuestDetailsNoFilterResults": "sample string 11",
    "GuestDetailsNoResults": "sample string 12",
    "GuestDetailsButtonText": "sample string 13",
    "SignoutAlert": {
      "Title": "sample string 1",
      "Description": "sample string 2",
      "Confirm": "sample string 3",
      "Decline": "sample string 4"
    },
    "GuestDetailsButtonAlert": {
      "Title": "sample string 1",
      "Description": "sample string 2",
      "Confirm": "sample string 3",
      "Decline": "sample string 4"
    },
    "GuestDetailsButtonSuccessAlert": {
      "Title": "sample string 1",
      "Description": "sample string 2",
      "Confirm": "sample string 3",
      "Decline": "sample string 4"
    }
  },
  "success": true
}

application/xml, text/xml

Sample:

<ResponseLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YourTicketAPI">
  <success>true</success>
  <JWTToken>sample string 3</JWTToken>
  <Login2FAAuthenticatorActivated>true</Login2FAAuthenticatorActivated>
  <Login2FAEnforce>true</Login2FAEnforce>
  <Message>sample string 4</Message>
  <ScanText>sample string 5</ScanText>
  <SettingsForApp>
    <APIPopupMinimumShownFor>3</APIPopupMinimumShownFor>
    <CameraPageScannerText>sample string 1</CameraPageScannerText>
    <FilesForApp>
      <FilesForApp>
        <Type>Success</Type>
        <Url>sample string 1</Url>
        <Version>sample string 2</Version>
      </FilesForApp>
      <FilesForApp>
        <Type>Success</Type>
        <Url>sample string 1</Url>
        <Version>sample string 2</Version>
      </FilesForApp>
    </FilesForApp>
    <GuestDetailsAllEventsDropdownText>sample string 8</GuestDetailsAllEventsDropdownText>
    <GuestDetailsAllEventsSubTitle>sample string 10</GuestDetailsAllEventsSubTitle>
    <GuestDetailsAllEventsTitle>sample string 9</GuestDetailsAllEventsTitle>
    <GuestDetailsButtonAlert>
      <Confirm>sample string 3</Confirm>
      <Decline>sample string 4</Decline>
      <Description>sample string 2</Description>
      <Title>sample string 1</Title>
    </GuestDetailsButtonAlert>
    <GuestDetailsButtonSuccessAlert>
      <Confirm>sample string 3</Confirm>
      <Decline>sample string 4</Decline>
      <Description>sample string 2</Description>
      <Title>sample string 1</Title>
    </GuestDetailsButtonSuccessAlert>
    <GuestDetailsButtonText>sample string 13</GuestDetailsButtonText>
    <GuestDetailsNoFilterResults>sample string 11</GuestDetailsNoFilterResults>
    <GuestDetailsNoResults>sample string 12</GuestDetailsNoResults>
    <GuestOpenInformationPopupButtonText>sample string 5</GuestOpenInformationPopupButtonText>
    <GuestSearchPlaceText>sample string 7</GuestSearchPlaceText>
    <GuestTitle>sample string 6</GuestTitle>
    <PopupShownFor>2</PopupShownFor>
    <ScanTimeout>4</ScanTimeout>
    <SignoutAlert>
      <Confirm>sample string 3</Confirm>
      <Decline>sample string 4</Decline>
      <Description>sample string 2</Description>
      <Title>sample string 1</Title>
    </SignoutAlert>
  </SettingsForApp>
</ResponseLogin>