POST api/customers/authenticate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Method	CustomerAuthenticationMethods	None.
PropertyId	integer	None.
EventSourceId	integer	None.
Username	string	None.
Password	string	None.
RoomNumber	string	None.
ReservationId	string	None.
GuestName	string	None.
PMSProperty	string	None.
GoogleIdToken	string	None.
clientId	string	None.
credential	string	None.
select_by	string	None.
Ucid	string	None.
LoyaltyPassword	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Method": 1,
  "PropertyId": 1,
  "EventSourceId": 2,
  "Username": "sample string 3",
  "Password": "sample string 4",
  "RoomNumber": "sample string 5",
  "ReservationId": "sample string 6",
  "GuestName": "sample string 7",
  "PMSProperty": "sample string 8",
  "GoogleIdToken": "sample string 9",
  "clientId": "sample string 10",
  "credential": "sample string 11",
  "select_by": "sample string 12",
  "Ucid": "sample string 13",
  "LoyaltyPassword": "sample string 14"
}

application/xml, text/xml

Sample:

<CustomerAuthenticationProviderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.ExtClients.CustomerAuthenticationProviders">
  <EventSourceId>2</EventSourceId>
  <GoogleClientId>sample string 10</GoogleClientId>
  <GoogleCredential>sample string 11</GoogleCredential>
  <GoogleIdToken>sample string 9</GoogleIdToken>
  <GoogleSelectBy>sample string 12</GoogleSelectBy>
  <GuestName>sample string 7</GuestName>
  <LoyaltyPassword>sample string 14</LoyaltyPassword>
  <Method>Internal</Method>
  <PMSProperty>sample string 8</PMSProperty>
  <Password>sample string 4</Password>
  <PropertyId>1</PropertyId>
  <ReservationId>sample string 6</ReservationId>
  <RoomNumber>sample string 5</RoomNumber>
  <Ucid>sample string 13</Ucid>
  <Username>sample string 3</Username>
</CustomerAuthenticationProviderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomerAuthenticationProviderResult

Name	Type	Additional information
Success	boolean	None.
FailureMessage	string	None.
Identity	ExternalCustomerIdentity	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "FailureMessage": "sample string 2",
  "Identity": {
    "Method": 1,
    "ProviderCode": "sample string 1",
    "ExternalId": "sample string 2",
    "CustomerId": 3,
    "CustomerFolderId": 4,
    "PropertyId": 5,
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "FullName": "sample string 8",
    "Email": "sample string 9",
    "MobilePhone": "sample string 10",
    "RoomNumber": "sample string 11",
    "ReservationId": "sample string 12",
    "Ucid": "sample string 13",
    "MustChangePassword": true
  }
}

application/xml, text/xml

Sample:

<CustomerAuthenticationProviderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.ExtClients.CustomerAuthenticationProviders">
  <FailureMessage>sample string 2</FailureMessage>
  <Identity>
    <CustomerFolderId>4</CustomerFolderId>
    <CustomerId>3</CustomerId>
    <Email>sample string 9</Email>
    <ExternalId>sample string 2</ExternalId>
    <FirstName>sample string 6</FirstName>
    <FullName>sample string 8</FullName>
    <LastName>sample string 7</LastName>
    <Method>Internal</Method>
    <MobilePhone>sample string 10</MobilePhone>
    <MustChangePassword>true</MustChangePassword>
    <PropertyId>5</PropertyId>
    <ProviderCode>sample string 1</ProviderCode>
    <ReservationId>sample string 12</ReservationId>
    <RoomNumber>sample string 11</RoomNumber>
    <Ucid>sample string 13</Ucid>
  </Identity>
  <Success>true</Success>
</CustomerAuthenticationProviderResult>