Backend for Frontend (0.1)

Download OpenAPI specification:Download

Christopher Cheng: christopher@skywidetech.com URL: https://www.skywidetech.com

REST API for Frontend

Get User Login

path Parameters

userLoginId

required

string

Responses

Response samples

Content type

application/json

{"currentPassword": "string",
"partyName": "string",
"givenName": "string",
"surname": "string",
"employerPartyId": 0,
"accountNotExpired": true,
"credentialsNonExpired": true,
"accountNonLocked": true,
"securityGroupSet": [{"groupId": 0,
"name": "string",
"description": "string",
"groupTypeId": "string",
"code": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
],
"securityPermissionSet": [{"permissionId": 0,
"code": "string",
"description": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
]
}
],
"userLoginSecurityGroupSet": [{"userLoginSecurityGroupId": 0,
"userLoginId": 0,
"groupId": 0,
"fromDate": "2019-08-24",
"thruDate": "2019-08-24"
}
],
"permissions": [0
]
}
],
"activationToken": "string",
"activationTokenExpiryDate": "2019-08-24T14:15:22Z",
"securityGroupNames": ["string"
],
"userLoginId": 0,
"qqOpenId": "string",
"weChatOpenID": "string",
"googleID": "string",
"facebookID": "string",
"appleID": "string",
"internalOpenID": "string",
"partyId": 0,
"username": "string",
"hashedPassword": "string",
"passwordHint": "string",
"system": true,
"enabled": true,
"active": true,
"hasLoggedOut": true,
"requirePasswordChange": true,
"lastCurrencyUom": "string",
"lastLocale": "string",
"lastTimeZone": "string",
"disableDateTime": "string",
"successiveFailedLogins": 0,
"domain": "string",
"userLoginTypeId": "string",
"facilityId": 0
}

Update user login

path Parameters

userLoginId

required

string

Request Body schema: application/json

currentPassword	string Current Password
partyName	string Party Name
givenName	string Given Name
surname	string Surname
employerPartyId	integer <int32> Employer Party ID
accountNotExpired	boolean Account Not expired
credentialsNonExpired	boolean Credentials Non Expired
accountNonLocked	boolean Account non locked
	Array of objects (SecurityGroup) unique Security Group List
activationToken	string
activationTokenExpiryDate	string <date-time>
securityGroupNames	Array of strings
userLoginId	integer <int32> Primary Key
qqOpenId	string QQ Open ID
weChatOpenID	string WeChat Open ID
googleID	string Google/Gmail ID
facebookID	string Facebook ID
appleID	string Apple ID
internalOpenID	string Internal Open ID
partyId	integer <int32> Party ID
username	string Username
hashedPassword	string Hashed Password
passwordHint	string Password Hint
system	boolean Is system user (super user)
enabled	boolean Enabled or disabled
active	boolean active or inactive
hasLoggedOut	boolean Has user logged out of the system
requirePasswordChange	boolean Require password change at next login
lastCurrencyUom	string Last Currency Unit of Measure
lastLocale	string Last used locale
lastTimeZone	string Last used time zone
disableDateTime	string Disable used of date/time
successiveFailedLogins	integer <int32> Total successive failed logins (block if exceed a number)
domain	string Domain
userLoginTypeId	string User Login Type ID
facilityId	integer <int32> Facility ID

Responses

Request samples

Payload

Content type

application/json

{"currentPassword": "string",
"partyName": "string",
"givenName": "string",
"surname": "string",
"employerPartyId": 0,
"accountNotExpired": true,
"credentialsNonExpired": true,
"accountNonLocked": true,
"securityGroupSet": [{"groupId": 0,
"name": "string",
"description": "string",
"groupTypeId": "string",
"code": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
],
"securityPermissionSet": [{"permissionId": 0,
"code": "string",
"description": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
]
}
],
"userLoginSecurityGroupSet": [{"userLoginSecurityGroupId": 0,
"userLoginId": 0,
"groupId": 0,
"fromDate": "2019-08-24",
"thruDate": "2019-08-24"
}
],
"permissions": [0
]
}
],
"activationToken": "string",
"activationTokenExpiryDate": "2019-08-24T14:15:22Z",
"securityGroupNames": ["string"
],
"userLoginId": 0,
"qqOpenId": "string",
"weChatOpenID": "string",
"googleID": "string",
"facebookID": "string",
"appleID": "string",
"internalOpenID": "string",
"partyId": 0,
"username": "string",
"hashedPassword": "string",
"passwordHint": "string",
"system": true,
"enabled": true,
"active": true,
"hasLoggedOut": true,
"requirePasswordChange": true,
"lastCurrencyUom": "string",
"lastLocale": "string",
"lastTimeZone": "string",
"disableDateTime": "string",
"successiveFailedLogins": 0,
"domain": "string",
"userLoginTypeId": "string",
"facilityId": 0
}

Response samples

Content type

application/json

{"echoToken": "string",
"timestamp": 0,
"target": "string",
"targetName": "string",
"version": "string",
"transactionIdentifier": "string",
"sequenceNmbr": 0,
"transactionStatusCode": "string",
"retransmissionIndicator": true,
"correlationID": "string",
"primaryLangID": "string",
"altLangID": "string",
"success": true,
"warnings": {"warnings": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"errors": {"errors": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"comment": {"language": "string",
"stringValue": "string"
},
"uniqueID": {"instance": "string",
"type": "string",
"company_name": {"code": "string"
},
"id": "string",
"url": "string",
"id_context": "string"
}
}

Delete user login

path Parameters

userLoginId

required

string

Responses

Response samples

Content type

application/json

{"echoToken": "string",
"timestamp": 0,
"target": "string",
"targetName": "string",
"version": "string",
"transactionIdentifier": "string",
"sequenceNmbr": 0,
"transactionStatusCode": "string",
"retransmissionIndicator": true,
"correlationID": "string",
"primaryLangID": "string",
"altLangID": "string",
"success": true,
"warnings": {"warnings": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"errors": {"errors": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"comment": {"language": "string",
"stringValue": "string"
},
"uniqueID": {"instance": "string",
"type": "string",
"company_name": {"code": "string"
},
"id": "string",
"url": "string",
"id_context": "string"
}
}

Update security groups

path Parameters

userLoginId

required

string

Request Body schema: application/json

currentPassword	string Current Password
partyName	string Party Name
givenName	string Given Name
surname	string Surname
employerPartyId	integer <int32> Employer Party ID
accountNotExpired	boolean Account Not expired
credentialsNonExpired	boolean Credentials Non Expired
accountNonLocked	boolean Account non locked
	Array of objects (SecurityGroup) unique Security Group List
activationToken	string
activationTokenExpiryDate	string <date-time>
securityGroupNames	Array of strings
userLoginId	integer <int32> Primary Key
qqOpenId	string QQ Open ID
weChatOpenID	string WeChat Open ID
googleID	string Google/Gmail ID
facebookID	string Facebook ID
appleID	string Apple ID
internalOpenID	string Internal Open ID
partyId	integer <int32> Party ID
username	string Username
hashedPassword	string Hashed Password
passwordHint	string Password Hint
system	boolean Is system user (super user)
enabled	boolean Enabled or disabled
active	boolean active or inactive
hasLoggedOut	boolean Has user logged out of the system
requirePasswordChange	boolean Require password change at next login
lastCurrencyUom	string Last Currency Unit of Measure
lastLocale	string Last used locale
lastTimeZone	string Last used time zone
disableDateTime	string Disable used of date/time
successiveFailedLogins	integer <int32> Total successive failed logins (block if exceed a number)
domain	string Domain
userLoginTypeId	string User Login Type ID
facilityId	integer <int32> Facility ID

Responses

Request samples

Payload

Content type

application/json

{"currentPassword": "string",
"partyName": "string",
"givenName": "string",
"surname": "string",
"employerPartyId": 0,
"accountNotExpired": true,
"credentialsNonExpired": true,
"accountNonLocked": true,
"securityGroupSet": [{"groupId": 0,
"name": "string",
"description": "string",
"groupTypeId": "string",
"code": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
],
"securityPermissionSet": [{"permissionId": 0,
"code": "string",
"description": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
]
}
],
"userLoginSecurityGroupSet": [{"userLoginSecurityGroupId": 0,
"userLoginId": 0,
"groupId": 0,
"fromDate": "2019-08-24",
"thruDate": "2019-08-24"
}
],
"permissions": [0
]
}
],
"activationToken": "string",
"activationTokenExpiryDate": "2019-08-24T14:15:22Z",
"securityGroupNames": ["string"
],
"userLoginId": 0,
"qqOpenId": "string",
"weChatOpenID": "string",
"googleID": "string",
"facebookID": "string",
"appleID": "string",
"internalOpenID": "string",
"partyId": 0,
"username": "string",
"hashedPassword": "string",
"passwordHint": "string",
"system": true,
"enabled": true,
"active": true,
"hasLoggedOut": true,
"requirePasswordChange": true,
"lastCurrencyUom": "string",
"lastLocale": "string",
"lastTimeZone": "string",
"disableDateTime": "string",
"successiveFailedLogins": 0,
"domain": "string",
"userLoginTypeId": "string",
"facilityId": 0
}

Response samples

Content type

application/json

{"echoToken": "string",
"timestamp": 0,
"target": "string",
"targetName": "string",
"version": "string",
"transactionIdentifier": "string",
"sequenceNmbr": 0,
"transactionStatusCode": "string",
"retransmissionIndicator": true,
"correlationID": "string",
"primaryLangID": "string",
"altLangID": "string",
"success": true,
"warnings": {"warnings": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"errors": {"errors": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"comment": {"language": "string",
"stringValue": "string"
},
"uniqueID": {"instance": "string",
"type": "string",
"company_name": {"code": "string"
},
"id": "string",
"url": "string",
"id_context": "string"
}
}

Change Password

path Parameters

userLoginId

required

string

Request Body schema: application/json

currentPassword	string Current Password
partyName	string Party Name
givenName	string Given Name
surname	string Surname
employerPartyId	integer <int32> Employer Party ID
accountNotExpired	boolean Account Not expired
credentialsNonExpired	boolean Credentials Non Expired
accountNonLocked	boolean Account non locked
	Array of objects (SecurityGroup) unique Security Group List
activationToken	string
activationTokenExpiryDate	string <date-time>
securityGroupNames	Array of strings
userLoginId	integer <int32> Primary Key
qqOpenId	string QQ Open ID
weChatOpenID	string WeChat Open ID
googleID	string Google/Gmail ID
facebookID	string Facebook ID
appleID	string Apple ID
internalOpenID	string Internal Open ID
partyId	integer <int32> Party ID
username	string Username
hashedPassword	string Hashed Password
passwordHint	string Password Hint
system	boolean Is system user (super user)
enabled	boolean Enabled or disabled
active	boolean active or inactive
hasLoggedOut	boolean Has user logged out of the system
requirePasswordChange	boolean Require password change at next login
lastCurrencyUom	string Last Currency Unit of Measure
lastLocale	string Last used locale
lastTimeZone	string Last used time zone
disableDateTime	string Disable used of date/time
successiveFailedLogins	integer <int32> Total successive failed logins (block if exceed a number)
domain	string Domain
userLoginTypeId	string User Login Type ID
facilityId	integer <int32> Facility ID

Responses

Request samples

Payload

Content type

application/json

{"currentPassword": "string",
"partyName": "string",
"givenName": "string",
"surname": "string",
"employerPartyId": 0,
"accountNotExpired": true,
"credentialsNonExpired": true,
"accountNonLocked": true,
"securityGroupSet": [{"groupId": 0,
"name": "string",
"description": "string",
"groupTypeId": "string",
"code": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
],
"securityPermissionSet": [{"permissionId": 0,
"code": "string",
"description": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
]
}
],
"userLoginSecurityGroupSet": [{"userLoginSecurityGroupId": 0,
"userLoginId": 0,
"groupId": 0,
"fromDate": "2019-08-24",
"thruDate": "2019-08-24"
}
],
"permissions": [0
]
}
],
"activationToken": "string",
"activationTokenExpiryDate": "2019-08-24T14:15:22Z",
"securityGroupNames": ["string"
],
"userLoginId": 0,
"qqOpenId": "string",
"weChatOpenID": "string",
"googleID": "string",
"facebookID": "string",
"appleID": "string",
"internalOpenID": "string",
"partyId": 0,
"username": "string",
"hashedPassword": "string",
"passwordHint": "string",
"system": true,
"enabled": true,
"active": true,
"hasLoggedOut": true,
"requirePasswordChange": true,
"lastCurrencyUom": "string",
"lastLocale": "string",
"lastTimeZone": "string",
"disableDateTime": "string",
"successiveFailedLogins": 0,
"domain": "string",
"userLoginTypeId": "string",
"facilityId": 0
}

Response samples

Content type

application/json

{"echoToken": "string",
"timestamp": 0,
"target": "string",
"targetName": "string",
"version": "string",
"transactionIdentifier": "string",
"sequenceNmbr": 0,
"transactionStatusCode": "string",
"retransmissionIndicator": true,
"correlationID": "string",
"primaryLangID": "string",
"altLangID": "string",
"success": true,
"warnings": {"warnings": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"errors": {"errors": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"comment": {"language": "string",
"stringValue": "string"
},
"uniqueID": {"instance": "string",
"type": "string",
"company_name": {"code": "string"
},
"id": "string",
"url": "string",
"id_context": "string"
}
}

Create a new user login

query Parameters

requiresSingleSignOn

boolean

Request Body schema: application/json

currentPassword	string Current Password
partyName	string Party Name
givenName	string Given Name
surname	string Surname
employerPartyId	integer <int32> Employer Party ID
accountNotExpired	boolean Account Not expired
credentialsNonExpired	boolean Credentials Non Expired
accountNonLocked	boolean Account non locked
	Array of objects (SecurityGroup) unique Security Group List
activationToken	string
activationTokenExpiryDate	string <date-time>
securityGroupNames	Array of strings
userLoginId	integer <int32> Primary Key
qqOpenId	string QQ Open ID
weChatOpenID	string WeChat Open ID
googleID	string Google/Gmail ID
facebookID	string Facebook ID
appleID	string Apple ID
internalOpenID	string Internal Open ID
partyId	integer <int32> Party ID
username	string Username
hashedPassword	string Hashed Password
passwordHint	string Password Hint
system	boolean Is system user (super user)
enabled	boolean Enabled or disabled
active	boolean active or inactive
hasLoggedOut	boolean Has user logged out of the system
requirePasswordChange	boolean Require password change at next login
lastCurrencyUom	string Last Currency Unit of Measure
lastLocale	string Last used locale
lastTimeZone	string Last used time zone
disableDateTime	string Disable used of date/time
successiveFailedLogins	integer <int32> Total successive failed logins (block if exceed a number)
domain	string Domain
userLoginTypeId	string User Login Type ID
facilityId	integer <int32> Facility ID

Responses

Request samples

Payload

Content type

application/json

{"currentPassword": "string",
"partyName": "string",
"givenName": "string",
"surname": "string",
"employerPartyId": 0,
"accountNotExpired": true,
"credentialsNonExpired": true,
"accountNonLocked": true,
"securityGroupSet": [{"groupId": 0,
"name": "string",
"description": "string",
"groupTypeId": "string",
"code": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
],
"securityPermissionSet": [{"permissionId": 0,
"code": "string",
"description": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
]
}
],
"userLoginSecurityGroupSet": [{"userLoginSecurityGroupId": 0,
"userLoginId": 0,
"groupId": 0,
"fromDate": "2019-08-24",
"thruDate": "2019-08-24"
}
],
"permissions": [0
]
}
],
"activationToken": "string",
"activationTokenExpiryDate": "2019-08-24T14:15:22Z",
"securityGroupNames": ["string"
],
"userLoginId": 0,
"qqOpenId": "string",
"weChatOpenID": "string",
"googleID": "string",
"facebookID": "string",
"appleID": "string",
"internalOpenID": "string",
"partyId": 0,
"username": "string",
"hashedPassword": "string",
"passwordHint": "string",
"system": true,
"enabled": true,
"active": true,
"hasLoggedOut": true,
"requirePasswordChange": true,
"lastCurrencyUom": "string",
"lastLocale": "string",
"lastTimeZone": "string",
"disableDateTime": "string",
"successiveFailedLogins": 0,
"domain": "string",
"userLoginTypeId": "string",
"facilityId": 0
}

Response samples

Content type

application/json

{"echoToken": "string",
"timestamp": 0,
"target": "string",
"targetName": "string",
"version": "string",
"transactionIdentifier": "string",
"sequenceNmbr": 0,
"transactionStatusCode": "string",
"retransmissionIndicator": true,
"correlationID": "string",
"primaryLangID": "string",
"altLangID": "string",
"success": true,
"warnings": {"warnings": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"errors": {"errors": [{"language": "string",
"type": "string",
"shortText": "string",
"code": "string",
"docURL": "string",
"status": "string",
"tag": "string",
"recordID": "string",
"stringValue": "string"
}
]
},
"comment": {"language": "string",
"stringValue": "string"
},
"uniqueID": {"instance": "string",
"type": "string",
"company_name": {"code": "string"
},
"id": "string",
"url": "string",
"id_context": "string"
}
}

User Authentication By Form Login

Request Body schema: application/x-www-form-urlencoded

property name*

additional property

string

Responses

Response samples

Content type

application/json

{"currentPassword": "string",
"partyName": "string",
"givenName": "string",
"surname": "string",
"employerPartyId": 0,
"accountNotExpired": true,
"credentialsNonExpired": true,
"accountNonLocked": true,
"securityGroupSet": [{"groupId": 0,
"name": "string",
"description": "string",
"groupTypeId": "string",
"code": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
],
"securityPermissionSet": [{"permissionId": 0,
"code": "string",
"description": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
]
}
],
"userLoginSecurityGroupSet": [{"userLoginSecurityGroupId": 0,
"userLoginId": 0,
"groupId": 0,
"fromDate": "2019-08-24",
"thruDate": "2019-08-24"
}
],
"permissions": [0
]
}
],
"activationToken": "string",
"activationTokenExpiryDate": "2019-08-24T14:15:22Z",
"securityGroupNames": ["string"
],
"userLoginId": 0,
"qqOpenId": "string",
"weChatOpenID": "string",
"googleID": "string",
"facebookID": "string",
"appleID": "string",
"internalOpenID": "string",
"partyId": 0,
"username": "string",
"hashedPassword": "string",
"passwordHint": "string",
"system": true,
"enabled": true,
"active": true,
"hasLoggedOut": true,
"requirePasswordChange": true,
"lastCurrencyUom": "string",
"lastLocale": "string",
"lastTimeZone": "string",
"disableDateTime": "string",
"successiveFailedLogins": 0,
"domain": "string",
"userLoginTypeId": "string",
"facilityId": 0
}

Check if a userLogin exists

path Parameters

userLoginId

required

string

Responses

Response samples

Content type

application/json

true

Get Security Groups

Responses

Response samples

Content type

application/json

[{"groupId": 0,
"name": "string",
"description": "string",
"groupTypeId": "string",
"code": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
],
"securityPermissionSet": [{"permissionId": 0,
"code": "string",
"description": "string",
"securityGroupPermissionSet": [{"securityGroupPermissionId": 0,
"securityGroupId": 0,
"permissionId": 0
}
]
}
],
"userLoginSecurityGroupSet": [{"userLoginSecurityGroupId": 0,
"userLoginId": 0,
"groupId": 0,
"fromDate": "2019-08-24",
"thruDate": "2019-08-24"
}
],
"permissions": [0
]
}
]

User Authentication By SSO

path Parameters

serverName

required

string

query Parameters

forwardToUrl required	string
forwardToFailedUrl required	string

Backend for Frontend (0.1)

User Login

Get User Login

path Parameters

Responses

Response samples

Update user login

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete user login

path Parameters

Responses

Response samples

Update security groups

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Change Password

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Create a new user login

query Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Hash a string

query Parameters

Responses

Response samples

User Authentication By Form Login

Request Body schema: application/x-www-form-urlencoded

Responses

Response samples

Check if a userLogin exists

path Parameters

Responses

Response samples

Get Security Groups

Responses

Response samples

User Authentication By SSO

path Parameters

query Parameters

Responses