A valid request URL is required to generate request examples{
"accountName": "...",
"appName": "...",
"customRules": [
{
"name": "...",
"sysidCustomRuleType": 12345,
"userRuleDefinitions": [
{
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidUserCustomRuleDefinition": 12345,
"description": "...",
"name": "..."
},
{
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidUserCustomRuleDefinition": 12345,
"description": "...",
"name": "..."
}
],
"description": "...",
"sysidCustomExecutionPoint": 12345,
"venueRuleDefinitions": [
{
"description": "...",
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidVenueCustomRuleDefinition": 12345,
"name": "..."
},
{
"description": "...",
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidVenueCustomRuleDefinition": 12345,
"name": "..."
}
],
"languageTagKey": "..."
},
{
"name": "...",
"sysidCustomRuleType": 12345,
"userRuleDefinitions": [
{
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidUserCustomRuleDefinition": 12345,
"description": "...",
"name": "..."
},
{
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidUserCustomRuleDefinition": 12345,
"description": "...",
"name": "..."
}
],
"description": "...",
"sysidCustomExecutionPoint": 12345,
"venueRuleDefinitions": [
{
"description": "...",
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidVenueCustomRuleDefinition": 12345,
"name": "..."
},
{
"description": "...",
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidVenueCustomRuleDefinition": 12345,
"name": "..."
}
],
"languageTagKey": "..."
}
],
"allowICS": true,
"userData": {
"sysidDefaultLocation": 12345,
"sysidApplicationUser": 12345,
"preferredName": "...",
"sysidDefaultResType": 12345,
"lastName": "...",
"authToken": "...",
"maxFutureReservationDays": 12345,
"userAuthRules": [
{
"sysidAuthorizationRule": 12345
},
{
"sysidAuthorizationRule": 12345
}
],
"sysidRole": 12345,
"sysidDefaultResCategory": 12345,
"sysidLanguage": 12345,
"preferences": [
{
"value": "...",
"comment": "...",
"key": "..."
},
{
"value": "...",
"comment": "...",
"key": "..."
}
],
"firstName": "...",
"reservationSpendingLimit": 12345,
"middleInitial": "...",
"sysidHomeLocation": 12345,
"defaultChargeCode": "..."
},
"accountOwner": true,
"sysidAccount": 12345,
"forumList": [
{
"visited": true,
"name": "...",
"sysid": 12345,
"homeForum": true
},
{
"visited": true,
"name": "...",
"sysid": 12345,
"homeForum": true
}
],
"sysidApplication": 12345
}Post login
Performs a user login to the agilquest system. The Application authentication token is required to identify the application it represents. The Application Authentication token is included as an HTTP header value under the custom header field AQOB-AppAuthToken . The POSTed LoginData information includes the following information:
On successful Login, this operation will return a User Auth Response value with account and User information, including the User Authentication Token.
The authToken value of the User Data returned from this operation is used to verify the rights and permissions of the User for all subsequent calls. Request for reservations, editing locations and resources, and other operations require a valid User Authentication Token in order to execute.
The User Authentication Token is associated with a session timeout. This timeout value is defined as a property of the Customer’s System configuration properties - that is, for a particular Account in the agilquest System.
Each time the User Authentication Token is submitted for an operation, it is checked to see if the token session has timed out. If the user session has not timed out, the session is renewed, i.e. that session elapsed time is reset to zero (0).
If the User Authentication Token is inactive for the period of time defined by the session time out property, meaning that the User performs no operations in the agilquest System and does not submit their authentication token to the agilquest System within that time period, the authentication token is expired. The User will have to reauthenticate with the agilquest System to reacquire a user authentication token.
A valid request URL is required to generate request examples{
"accountName": "...",
"appName": "...",
"customRules": [
{
"name": "...",
"sysidCustomRuleType": 12345,
"userRuleDefinitions": [
{
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidUserCustomRuleDefinition": 12345,
"description": "...",
"name": "..."
},
{
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidUserCustomRuleDefinition": 12345,
"description": "...",
"name": "..."
}
],
"description": "...",
"sysidCustomExecutionPoint": 12345,
"venueRuleDefinitions": [
{
"description": "...",
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidVenueCustomRuleDefinition": 12345,
"name": "..."
},
{
"description": "...",
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidVenueCustomRuleDefinition": 12345,
"name": "..."
}
],
"languageTagKey": "..."
},
{
"name": "...",
"sysidCustomRuleType": 12345,
"userRuleDefinitions": [
{
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidUserCustomRuleDefinition": 12345,
"description": "...",
"name": "..."
},
{
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidUserCustomRuleDefinition": 12345,
"description": "...",
"name": "..."
}
],
"description": "...",
"sysidCustomExecutionPoint": 12345,
"venueRuleDefinitions": [
{
"description": "...",
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidVenueCustomRuleDefinition": 12345,
"name": "..."
},
{
"description": "...",
"languageTagKey": "...",
"sysidAttributeDataType": 12345,
"sysidVenueCustomRuleDefinition": 12345,
"name": "..."
}
],
"languageTagKey": "..."
}
],
"allowICS": true,
"userData": {
"sysidDefaultLocation": 12345,
"sysidApplicationUser": 12345,
"preferredName": "...",
"sysidDefaultResType": 12345,
"lastName": "...",
"authToken": "...",
"maxFutureReservationDays": 12345,
"userAuthRules": [
{
"sysidAuthorizationRule": 12345
},
{
"sysidAuthorizationRule": 12345
}
],
"sysidRole": 12345,
"sysidDefaultResCategory": 12345,
"sysidLanguage": 12345,
"preferences": [
{
"value": "...",
"comment": "...",
"key": "..."
},
{
"value": "...",
"comment": "...",
"key": "..."
}
],
"firstName": "...",
"reservationSpendingLimit": 12345,
"middleInitial": "...",
"sysidHomeLocation": 12345,
"defaultChargeCode": "..."
},
"accountOwner": true,
"sysidAccount": 12345,
"forumList": [
{
"visited": true,
"name": "...",
"sysid": 12345,
"homeForum": true
},
{
"visited": true,
"name": "...",
"sysid": 12345,
"homeForum": true
}
],
"sysidApplication": 12345
}Authorizations
Response
AuthResponse (or Response(AgilquestExceptionData) if there are any agilquest Exceptions)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
{
"sysidDefaultLocation": 12345,
"sysidApplicationUser": 12345,
"preferredName": "...",
"sysidDefaultResType": 12345,
"lastName": "...",
"authToken": "...",
"maxFutureReservationDays": 12345,
"userAuthRules": [
{ "sysidAuthorizationRule": 12345 },
{ "sysidAuthorizationRule": 12345 }
],
"sysidRole": 12345,
"sysidDefaultResCategory": 12345,
"sysidLanguage": 12345,
"preferences": [
{
"value": "...",
"comment": "...",
"key": "..."
},
{
"value": "...",
"comment": "...",
"key": "..."
}
],
"firstName": "...",
"reservationSpendingLimit": 12345,
"middleInitial": "...",
"sysidHomeLocation": 12345,
"defaultChargeCode": "..."
}
Show child attributes
Show child attributes