OBEProviderImpl Resource

The base provider. All providers should have similar functionality to this. Hopefully these methods are fairly self-explanatory. Think of these as 'tool box' functions to help generate services quickly.

GET /obe/getAllOBEs

Retrieve a list of all supported online booking engines.

Response Body
media type data type description
application/json array of OnlineBookingEngine (JSON) a list off all the OnlineBookingEngines.
application/xml list of onlineBookingEngine (XML)

Example

Request
GET /obe/getAllOBEs
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "code" : "...",
  "name" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

POST /obe/getConcurAuthTokenByTokenString

Get the concur auth token by the token auth string.

Request Body
media type data type description
application/json string (JSON) The authentication token received by the OBE.
application/xml string (XML)
Response Body
media type data type description
application/json ConcurAuthToken (JSON) The full token that matches the auth token received from an OBE, including account information.
application/xml concurAuthToken (XML)

Example

Request
POST /obe/getConcurAuthTokenByTokenString
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "token" : "...",
  "refreshToken" : "...",
  "expirationDate" : 12345,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "username" : "...",
  "password" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /obe/refreshConcurOAuthTokens

Refresh all concur oauth tokens to today's current date.

Request Body
media type data type description
application/json number (JSON) The date to refresh concur oauth tokens to.
application/xml dateTime (XML)
Response Body
media type data type description
application/json StatusResponse (JSON) A status response message detailing the success.
application/xml statusResponse (XML)

Example

Request
POST /obe/refreshConcurOAuthTokens
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "success" : true,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /obe/getConcurAuthTokenByClientId/{clientId}

Get the authentication token for an account's OBE login using the Airportal client ID.

Request Parameters
name type description constraints
clientId path The internal Airportal client ID for this account. long
Response Body
media type data type description
application/json ConcurAuthToken (JSON) The authentication token for this account's OBE login.
application/xml concurAuthToken (XML)

Example

Request
GET /obe/getConcurAuthTokenByClientId/{clientId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "token" : "...",
  "refreshToken" : "...",
  "expirationDate" : 12345,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "username" : "...",
  "password" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /obe/subscribeToService/{type}

Subscribe to an obe service.

Request Parameters
name type description
type path The type of service to subscribe to.
Request Body
media type data type description
application/json string (JSON) The authentication token for the service.
application/xml string (XML)
Response Body
media type data type description
application/json StatusResponse (JSON) A status response message detailing the success.
application/xml statusResponse (XML)

Example

Request
POST /obe/subscribeToService/{type}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "success" : true,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /obe/getConcurOAuthToken/{clientId}/{username}/{password}

Get a concur auth token for a user in an online booking engine.

Request Parameters
name type description constraints
clientId path The internal Airportal ID of an account. long
password path The password of the user in the OBE.  
username path The username of the user in the OBE.  
Response Body
media type data type description
application/json ConcurAuthToken (JSON) A token that can be reused to log in as this user to the OBE.
application/xml concurAuthToken (XML)

Example

Request
GET /obe/getConcurOAuthToken/{clientId}/{username}/{password}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "token" : "...",
  "refreshToken" : "...",
  "expirationDate" : 12345,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "username" : "...",
  "password" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}