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 logincredential
Performs a agilquest user login with user credentials. The User credentials are defined by a credential type ID and value for authentication.
This operation requires a Credentials Login Request argument, which contains a User Credentials Value and an optional Integer sysidAccount.
The Credential value includes a sysidCredentialsType value indicating the numeric Sysid of the Credentials Type this credential value represents, and a String credentialsValue that represents the required matching value that the login must provide. The Credentials Type is a customer specific value defined for an individual account in the agilquest System. A Credentials Type includes a boolean value indicating if the type uses encryption, the name of the type, and a Sysid assigned to the type by the agilquest System.
An example would be a Credentials Type called BAR_CODE with a encryption value of TRUE and a Sysid value of 1. The barcode value would be the value interpreted from the barcode reader (e.g. from a Badge or some sort of identification)
On successful Login, this operation will return a User Auth Response value with account and User information, including the User Authentication Token.
Perhaps the most important information obtained from the authentication results is the authToken value obtained from the User Data. This token is used for most, if not all, subsequent operations involving requests on behalf of the User. These include creating reservations, viewing resources, viewing locations, and other User based operations.
The User Authentication Token is associated with a session timeout. This timeout value is defined as a property of the Customer’s agilquest 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 renews, 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, 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
Body
CredentialLoginRequest
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