response
Copy Page
Core API
common
auth
user
Generate Tokens
current-user
Set Pin
Set Security QAs
system
List Roles
List User Directives
List State Codes
host
auth
client
Authenticate Client
user
Authenticate User
Authenticate User With Security QAs
franchises
franchise
info
Get Franchise Info
Update Franchise Info
security-questions
List Questions
Set Questions
user-groups
group
members
member
Remove Member
Member In Group
Add Member
List Members
Get Details
List User Groups
users
user
directives
List Directives
Set Directive
Clear Directive
Get User Info By ID
Get User Info By Login
Update User Info For Id
Update User Info For Login
Delete User
List Answered Security Questions
Set Login
Set Password
Set Pin
Add User
List Users
Delete Franchise
Add Franchise
List Franchises
stores
store
admins
Add Admin
List Admins
counters
Add Counter
List Counters
info
Get Store Info
Update Store Info
logo
Get Store Logo
Update Store Logo
managers
Add Manager
List Managers
user-groups
group
members
member
Remove Member
Member In Group
Add Member
List Members
Get Details
List User Groups
Delete Store
Add Store
List Stores
store
auth
client
Authenticate Client
user
Authenticate User
Authenticate User With Security QAs
admins
Add Admin
List Admins
counters
Add Counter
List Counters
managers
Add Manager
List Managers
security-questions
List Questions
store-info
Get Store Info
Update Store Info
store-logo
Get Store Logo
Update Store Logo
user-groups
group
members
member
Remove Member
Member In Group
Add Member
List Members
Get Details
List User Groups
users
user
Get User Info By ID
Get User Info By Login
Update User Info For Id
Update User Info For Login
Delete User
List Answered Security Questions
List Directives
Set Directive
Set Login
Set Password
Set Pin
Add User
List Users
Schemas
request
store
AuthenticateStoreClientRequest
AuthenticateStoreUserRequest
AuthenticateStoreUserSecurityQasRequest
host
AuthenticateClientRequest
AuthenticateUserRequest
AuthenticateUserSecurityQasRequest
AddFranchiseRequest
AddStoreRequest
SetFranchiseSecurityQuestions
UpdateFranchiseInfoRequest
AddUserRequest
AddGroupMemberRequest
UpdateUserInfoRequest
UpdateStoreInfoRequest
SetUserLoginRequest
SetUserPinRequest
SetUserPasswordRequest
SetUserSecurityQasRequest
response
AuthenticateUserResponse
BooleanResponse
FailureResponse
GenerateTokensResponse
GetFranchiseDetailsResponse
GetFranchiseSummaryResponse
GetStoreDetailsResponse
GetStoreSummaryResponse
GetUserResponse
GetUserGroupDetailsResponse
ListFranchisesResponse
ListGroupMembersResponse
ListRolesResponse
ListSecurityQuestionsResponse
ListUsersResponse
ListUserDirectivesResponse
ListUserGroupsResponse
ListStatesResponse
UpdateStoreLogoResponse
Address
FranchiseDetails
FranchiseSummary
ImageUploadInfo
Role
StoreDetails
User
UserGroupDetails
UserGroupSummary
SecurityQuestion
StoreSummary
UserActivityInfo
UserSecurityQA
UsState
response
Copy Page
GetFranchiseDetailsResponse
{
"data"
:
{
"id"
:
1
,
"name"
:
"string"
,
"description"
:
"string"
,
"numStores"
:
1
}
}