saherelm/xSaherelmWorkspace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
e9deaaa4b146b371afd4e9718849e2208e5fb004
xSaherelmWorkspace/Documents/OpenApi/HoppScotch/xSaherElm API-openapi.json
T
saherelm e9deaaa4b1 last ...
2026-10-01 01:16:52 +03:30

10419 lines
290 KiB
JSON
Raw Blame History

{
"openapi": "3.1.0",
"info": {
"title": "xSaherElm API",
"description": "Complete API Documentation",
"version": "1.0.0"
},
"paths": {
"/Account/Ban": {
"post": {
"summary": "Ban Specific Users",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "Ban_Specific_Users",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/UnBan": {
"post": {
"summary": "UnBann Specific Users",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "UnBann_Specific_Users",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/IsBanned/{userSelectByParam}": {
"get": {
"summary": "Check Specific User is Banned or not",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_Specific_User_is_Banned_or_not",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "userSelectByParam",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/DiscoveryDocument": {
"get": {
"summary": "Retrieve OAuth Discovery Document",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Retrieve_OAuth_Discovery_Document",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/RequestScopeAccessToken": {
"post": {
"summary": "Request AccessToken for Specific XApiScope",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"accessToken": "string",
"refreshToken": "string",
"expiresAt": 0
}
}
}
}
},
"operationId": "Request_AccessToken_for_Specific_XApiScope",
"tags": [
"Account"
],
"parameters": [
{
"name": "scope",
"in": "header",
"schema": {
"type": "string"
},
"description": "a member of <see>XApiScope</see>"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Authenticate": {
"post": {
"summary": "Authenticate User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"accessToken": "string",
"refreshToken": "string",
"expiresAt": 0
}
}
}
}
},
"description": "Sample request:\r\n\r\n {\r\n \"password\": \"\",\r\n \"userSelectBy\": \"\",\r\n }",
"operationId": "Authenticate_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Login": {
"post": {
"summary": "Authenticate User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"accessToken": "string",
"refreshToken": "string",
"expiresAt": 0,
"profile": {
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
}
}
}
}
},
"description": "Sample request:\r\n\r\n {\r\n \"language\": \"fa-IR\"\r\n \"password\": \"\",\r\n \"userSelectBy\": \"\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Authenticate_User_2",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Logout": {
"post": {
"summary": "Logout User",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Logout_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/RefreshTokens": {
"post": {
"summary": "Refresh Expired Tokens",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"accessToken": "string",
"refreshToken": "string",
"expiresAt": 0
}
}
}
}
},
"description": "in addition to AccessToken, you had to pass RefreshToken due to Headers",
"operationId": "Refresh_Expired_Tokens",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Validate": {
"post": {
"summary": "Validate a Revision Checksum",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Validate_a_Revision_Checksum",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/ChangePassword": {
"post": {
"summary": "Change a User's Password ...",
"responses": {
"200": {
"description": "Success"
}
},
"description": " for this action you have to provide:\r\n - Lang: client device currently used locale, such as: en-US.\r\n - Password: user's current active password.\r\n - NewPassword: user's new password to change.\r\n - Device: user's client device which is an instance of XDevice.\r\n - ReturnUrl: client application Login URL.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"password\": \"\"\r\n \"newPassword\": \"\",\r\n \"returnUrl\": \"http://localhost/login\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Change_a_Users_Password_",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Friendship/{destUser}/Follow": {
"post": {
"summary": "Follow a User",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Follow_a_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/Cancel": {
"post": {
"summary": "Cancel Following Request",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Cancel_Following_Request",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/UnFollowFollower": {
"post": {
"summary": "Unfollow a Follower",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Unfollow_a_Follower",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/UnFollowFollowing": {
"post": {
"summary": "Unfollow Following",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Unfollow_Following",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/Block": {
"post": {
"summary": "Block a Follower",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Block_a_Follower",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/UnBlock": {
"post": {
"summary": "Unblock a Blocked User",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Unblock_a_Blocked_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/AcceptRequest": {
"post": {
"summary": "Accept a Following Request",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Accept_a_Following_Request",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/RejectRequest": {
"post": {
"summary": "Reject a Following Request",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Reject_a_Following_Request",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/FriendshipInfo": {
"get": {
"summary": "Get Friendship Info Model between Specific User and Current User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
}
}
}
}
},
"operationId": "Get_Friendship_Info_Model_between_Specific_User_and_Current_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/IsFollower": {
"get": {
"summary": "Check a User IsFollower of Requested User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_a_User_IsFollower_of_Requested_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/FollowerState": {
"get": {
"summary": "Get Follower State of a User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": 0
}
}
}
},
"operationId": "Get_Follower_State_of_a_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/Follower": {
"get": {
"summary": "Get Specific Follower",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Get_Specific_Follower",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/Followers": {
"get": {
"summary": "Get Followers List Of Current User",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Get_Followers_List_Of_Current_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Friendship/AllFollowers": {
"get": {
"summary": "Get All Followers List Includes Blocked, Requested and etc \r\nof Current User",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Get_All_Followers_List_Includes_Blocked_Requested_and_etc_of_Current_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Friendship/QueryFollowers": {
"get": {
"summary": "Get All Followers List Includes Blocked, Requested and etc \r\nof Current User based On Query Model ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"avatar": "string",
"userId": "string",
"username": "string",
"lastname": "string",
"firstname": "string",
"type": 0,
"state": 0
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Get_All_Followers_List_Includes_Blocked_Requested_and_etc_of_Current_User_based_On_Query_Model_",
"tags": [
"Account"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "destUser",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Friendship/{destUser}/IsFollowing": {
"get": {
"summary": "Check a User is in Followings of Current User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_a_User_is_in_Followings_of_Current_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/FollowingState": {
"get": {
"summary": "Get Following State Relation between Specific User \r\nand Current User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": 0
}
}
}
},
"operationId": "Get_Following_State_Relation_between_Specific_User_and_Current_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/{destUser}/Following": {
"get": {
"summary": "Get Specific Following Model",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Get_Specific_Following_Model",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "destUser",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Friendship/Followings": {
"get": {
"summary": "Get Followings of Current User",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Get_Followings_of_Current_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Friendship/AllFollowings": {
"get": {
"summary": "Get All Following List Includes Blocked, Requested and etc \r\nof Current User",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Get_All_Following_List_Includes_Blocked_Requested_and_etc_of_Current_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Friendship/FollowingsList": {
"get": {
"summary": "Return Following UserName's List of Current User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "Return_Following_UserNames_List_of_Current_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Friendship/FollowersList": {
"get": {
"summary": "Return Followers UserName's List of Current User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "Return_Followers_UserNames_List_of_Current_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Friendship/QueryFollowings": {
"get": {
"summary": "Get All Followings List Includes Blocked, Requested and etc \r\nof Current User based On Query Model ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"avatar": "string",
"userId": "string",
"username": "string",
"lastname": "string",
"firstname": "string",
"type": 0,
"state": 0
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Get_All_Followings_List_Includes_Blocked_Requested_and_etc_of_Current_User_based_On_Query_Model_",
"tags": [
"Account"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "destUser",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/GetUserInfo": {
"get": {
"summary": "Untitled Request",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "Untitled_Request",
"tags": [
"Account"
],
"parameters": [
{
"name": "request",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "token",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/GetUserInfoByDevice": {
"get": {
"summary": "Untitled Request",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "Untitled_Request_2",
"tags": [
"Account"
],
"parameters": [
{
"name": "userSelectByParam",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Profile/{ids}/GetNames": {
"get": {
"summary": "Retrieve User Names based on UserIds",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "Retrieve_User_Names_based_on_UserIds",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "ids",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Profile/GetNameIds": {
"post": {
"summary": "get user ids and retrieve corresponding user names",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": "string",
"userName": "string"
}
]
}
}
}
},
"operationId": "get_user_ids_and_retrieve_corresponding_user_names",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Profile/{userSelectByParam}": {
"get": {
"summary": "Get Profile Object of Specific User",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
}
}
}
},
"operationId": "Get_Profile_Object_of_Specific_User",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "userSelectByParam",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"post": {
"summary": "Update a User Profile based on <see>XProfileUpdateRequest</see> Full",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
}
}
}
},
"operationId": "Update_a_User_Profile_based_on_seeXProfileUpdateRequestsee_Full",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "userSelectByParam",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Profile/Query": {
"get": {
"summary": "Query Users \r\nfor specifiy users role for query user 'role: string' and 'forceRole: boolean' in header",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Query_Users_for_specifiy_users_role_for_query_user_role_string_and_forceRole_boolean_in_header",
"tags": [
"Account"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "role",
"in": "header",
"schema": {
"type": "string"
},
"description": "an string which represent user role"
},
{
"name": "forceRole",
"in": "header",
"schema": {
"type": "string"
},
"example": "false",
"description": "if it's true the user must has exact role, otherwise top level users also listed"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Profile/Avatars/Query/{userSelectByParam}": {
"get": {
"summary": "Query Specified User's Profile Images",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Query_Specified_Users_Profile_Images",
"tags": [
"Account"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "userSelectByParam",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Profile/Update/{userSelectByParam}": {
"post": {
"summary": "Update User Profile based on <see>XProfileUpdateRequest</see> (FirstName/LastName/DateOfBirth)",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
}
}
}
},
"operationId": "Update_User_Profile_based_on_seeXProfileUpdateRequestsee_FirstNameLastNameDateOfBirth",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "userSelectByParam",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Profile/Avatar": {
"post": {
"summary": "Add a New Profile Image",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
}
}
}
},
"operationId": "Add_a_New_Profile_Image",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"ContentType": {
"type": "string",
"example": ""
},
"ContentDisposition": {
"type": "string",
"example": ""
},
"Headers": {
"type": "string",
"example": ""
},
"Length": {
"type": "string",
"example": ""
},
"Name": {
"type": "string",
"example": ""
},
"FileName": {
"type": "string",
"example": ""
}
}
}
}
}
}
}
},
"/Account/Profile/Avatars": {
"post": {
"summary": "Add a New Collection of Profile Images",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
}
}
}
},
"operationId": "Add_a_New_Collection_of_Profile_Images",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"files": {
"type": "string",
"example": ""
}
}
}
}
}
}
}
},
"/Account/Profile/Avatars/{id}/Set": {
"post": {
"summary": "set Specified Profile Image as Avatar",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
}
}
}
},
"operationId": "set_Specified_Profile_Image_as_Avatar",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/Profile/Avatars/{ids}": {
"delete": {
"summary": "Remove Profile Images",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
}
}
}
},
"operationId": "Remove_Profile_Images",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "ids",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/CanRegisterUserName/{userName}": {
"get": {
"summary": "Check a UserName is Available For Registration or not",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_a_UserName_is_Available_For_Registration_or_not",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "userName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/CanRegisterMobileNumber/{mobileNumber}": {
"get": {
"summary": "Check a Mobile Number is Available For Registration or not",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_a_Mobile_Number_is_Available_For_Registration_or_not",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "mobileNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/CanRegisterEmail/{email}": {
"get": {
"summary": "Check a Email Address is Available For Registration or not",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_a_Email_Address_is_Available_For_Registration_or_not",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "email",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/Account/InviteUser": {
"post": {
"summary": "Invite a User to Register on Dashboard",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"token": "string",
"expiration": "string"
}
}
}
}
},
"description": " for this action you have to provide: \r\n - Lang: client device currently used locale, such as: en-US.\r\n - Email: which email address is going to invite.\r\n - Device: user's client device which is an instance of XDevice.\r\n - ReturnUrl: client application Registration URL.\r\n notice in this step you had to provide all this informations as FormData\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"email\": \"\",\r\n \"returnUrl\": \"\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Invite_a_User_to_Register_on_Dashboard",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/RequestRegistration": {
"post": {
"summary": "Recieve some Basic Informations and Start Registration Proccess\r\nif they Valid \r\n\r\nRegistration Proccess Starts with Invoking this Action",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"token": "string",
"expiration": "string"
}
}
}
}
},
"description": " for this action you have to provide: \r\n - Lang: client device currently used locale, such as: en-US.\r\n - FirstName: user's FirstName.\r\n - LastName: user's LastName.\r\n - DateOfBirth: user's dob date.\r\n - MobileNumber: user's MobileNumber optional.\r\n - Email: user's Email optional.\r\n - ActionToken: user's requested action token for this action (if user invited). \r\n - Device: user's client device which is an instance of XDevice.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"firstName\": \"\",\r\n \"lastName\": \"\",\r\n \"dateOfBirth\": \"\",\r\n \"email\": \"\",\r\n \"mobileNumber\": \"\",\r\n \"actionToken\": \"\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Recieve_some_Basic_Informations_and_Start_Registration_Proccess_if_they_Valid_Registration_Proccess_Starts_with_Invoking_this_Action",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/AddAccountInfo": {
"post": {
"summary": "Add User Account Informations",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"token": "string",
"expiration": "string"
}
}
}
}
},
"description": " for this action you have to provide: \r\n - Lang: client device currently used locale, such as: en-US.\r\n - ActionToken: user's requested action token for this action.\r\n - UserName: user name.\r\n - Password: assigne password.\r\n - Device: user's client device which is an instance of XDevice.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"userName\": \"\",\r\n \"password\": \"\",\r\n \"actionToken\": \"\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Add_User_Account_Informations",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/AttachProfileImage": {
"post": {
"summary": "Upload and Attach a Profile Image for User. this is an Optional Step",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"token": "string",
"expiration": "string"
}
}
}
}
},
"operationId": "Upload_and_Attach_a_Profile_Image_for_User_this_is_an_Optional_Step",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"actionToken": {
"type": "string",
"example": ""
},
"ContentType": {
"type": "string",
"example": ""
},
"ContentDisposition": {
"type": "string",
"example": ""
},
"Headers": {
"type": "string",
"example": ""
},
"Length": {
"type": "string",
"example": ""
},
"Name": {
"type": "string",
"example": ""
},
"FileName": {
"type": "string",
"example": ""
}
}
}
}
}
}
}
},
"/Account/FinishRegistration": {
"post": {
"summary": "Finish Registrationn Proccess",
"responses": {
"200": {
"description": "Success"
}
},
"description": " for this action you have to provide: \r\n - a proper User Identifier such as: (UserId, UserName, Email or MobileNumber).\r\n - Lang: client device currently used locale, such as: en-US.\r\n - ActionToken: user's requested action token for this action.\r\n - Password: assigne password.\r\n - Device: user's client device which is an instance of XDevice.\r\n - ReturnUrl: client application Login URL.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"userName\": \"\",\r\n \"password\": \"\",\r\n \"returnUrl\": \"\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Finish_Registrationn_Proccess",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/IsConfirmedEmail": {
"get": {
"summary": "Check User is Confirmed Email or not",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_User_is_Confirmed_Email_or_not",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/IsConfirmedMobile": {
"get": {
"summary": "Check User is Confirmed Mobile or not",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_User_is_Confirmed_Mobile_or_not",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/RequestConfirmRegistration": {
"post": {
"summary": "Request Registration Confirm",
"responses": {
"200": {
"description": "Success"
}
},
"description": " for this action you have to provide:\r\n - a UserSelectedBy identifier which represet User.\r\n - Lang: client device currently used locale, such as: en-US.\r\n - Password: user's current active password.\r\n - Device: user's client device which is an instance of XDevice.\r\n - ReturnUrl: client application Confirm Registration URL.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"userId\": \"\"\r\n \"password\": \"\",\r\n \"returnUrl\": \"http://localhost/confirm\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Request_Registration_Confirm",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/ConfirmRegistration": {
"post": {
"summary": "Confirm Registration",
"responses": {
"200": {
"description": "Success"
}
},
"description": " for this action you have to provide:\r\n - Lang: client device currently used locale, such as: en-US.\r\n - ActionToken: user's requested action token for this action.\r\n - Device: user's client device which is an instance of XDevice.\r\n - ReturnUrl: client application Login URL.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"actionToken\": \"\"\r\n \"returnUrl\": \"http://localhost/login\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Confirm_Registration",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/RequestConfirmMobile": {
"post": {
"summary": "Request For Mobile Number Change/Confirm",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"token": "string",
"expiration": "string"
}
}
}
}
},
"description": " for this action you have to provide: \r\n - Lang: client device currently used locale, such as: en-US.\r\n - Password: user's current active password.\r\n - MobileNumber: which phone number is going to confirm.\r\n - Device: user's client device which is an instance of XDevice.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"password\": \"\",\r\n \"mobileNumber\": \"\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Request_For_Mobile_Number_ChangeConfirm",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/ConfirmMobileNumber": {
"post": {
"summary": "Confirm Requested Mobile Number",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"token": "string",
"expiration": "string"
}
}
}
}
},
"description": " for this action you have to provide:\r\n - Lang: client device currently used locale, such as: en-US. \r\n - ActionToken: user's requested action token for this action. \r\n - Device: user's client device which is an instance of XDevice. \r\n - MobileVerificationCode: a verification code which produced due Request Action.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"actionToken\": \"\"\r\n \"mobileVerificationCode\": \"\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Confirm_Requested_Mobile_Number",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/RequestConfirmEmail": {
"post": {
"summary": "Request For Email Address Change/Confirm",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"token": "string",
"expiration": "string"
}
}
}
}
},
"description": " for this action you have to provide:\r\n - Lang: client device currently used locale, such as: en-US.\r\n - Password: user's current active password.\r\n - Email: which email address is going to confirm.\r\n - Device: user's client device which is an instance of XDevice.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"password\": \"\",\r\n \"email\": \"\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Request_For_Email_Address_ChangeConfirm",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/ConfirmEmailAddress": {
"post": {
"summary": "Confirm Requested Email Address",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"token": "string",
"expiration": "string"
}
}
}
}
},
"description": " for this action you have to provide: \r\n - Lang: client device currently used locale, such as: en-US. \r\n - ActionToken: user's requested action token for this action. \r\n - Device: user's client device which is an instance of XDevice. \r\n - EmailVerificationCode: a verification code which produced due Request Action.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"actionToken\": \"\"\r\n \"emailVerificationCode\": \"\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Confirm_Requested_Email_Address",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/RequestResetPassword": {
"post": {
"summary": "Request Reset Password Action",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"token": "string",
"expiration": "string"
}
}
}
}
},
"description": " for this action you have to provide:\r\n - Lang: client device currently used locale, such as: en-US.\r\n - Device: user's client device which is an instance of XDevice.\r\n - ReturnUrl: client application ResetPassword URL.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"returnUrl\": \"http://localhost/reset-password\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Request_Reset_Password_Action",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/ResetPassword": {
"post": {
"summary": "Reset a User's Password",
"responses": {
"200": {
"description": "Success"
}
},
"description": " for this action you have to provide:\r\n - Lang: client device currently used locale, such as: en-US.\r\n - ActionToken: user's requested action token for this action.\r\n - NewPassword: user's new password to change.\r\n - Device: user's client device which is an instance of XDevice.\r\n - ReturnUrl: client application Login URL.\r\n\r\nSample request:\r\n\r\n {\r\n \"lang\": \"fa-IR\",\r\n \"actionToken\": \"\",\r\n \"newPassword\": \"\",\r\n \"returnUrl\": \"http://localhost/login\",\r\n \"device\": {\r\n \"os\":\"Mac\",\r\n \"browser\":\"Chrome\",\r\n \"osVersion\":\"mac-os-x-15\",\r\n \"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36\",\r\n \"deviceType\":3,\r\n \"identifier\":\"[Mac]-[mac-os-x-15]-[3]-[Chrome]-[Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) x-framework-test/0.0.0 Chrome/87.0.4280.141 Electron/11.2.0 Safari/537.36]\",\r\n \"token\":\"96f400dd9aa5c57a8cec9d6f4775bad3\"\r\n }\r\n }",
"operationId": "Reset_a_Users_Password",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/OpenToSearch/Query": {
"get": {
"summary": "Query Open To Search Users Profiles ... \r\nQuery all Users Which their Profiles is Open To Search ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"userId": "string",
"userName": "string",
"email": "string",
"emailConfirmed": true,
"phoneNumber": "string",
"phoneNumberConfirmed": true,
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"creationDate": "string",
"lastLogin": "string",
"avatar": "string",
"gender": 0,
"bio": "string",
"coverImage": "string",
"openToSearch": true,
"friendshipInfo": {
"userId": "string",
"isFollower": true,
"isFollowing": true,
"followerState": 0,
"followingState": 0,
"followers": 0,
"followings": 0
},
"roles": [
"string"
],
"avatars": [
{
"id": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"creationDate": "string"
}
],
"isEnable": true,
"isBanned": true
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Query_Open_To_Search_Users_Profiles_Query_all_Users_Which_their_Profiles_is_Open_To_Search_",
"tags": [
"Account"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Account/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter",
"tags": [
"Account"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/": {
"get": {
"summary": "Show Configured Welcome Message",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "Show_Configured_Welcome_Message",
"tags": [
"Startup"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_2",
"tags": [
"Startup"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_2",
"tags": [
"Startup"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/api/v{version}/StringProvider/Languages": {
"get": {
"summary": "Retrieve a List of Exists Languages ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "Retrieve_a_List_of_Exists_Languages_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/ResourceTitles": {
"get": {
"summary": "Retrieve a List of Resource Titles ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "Retrieve_a_List_of_Resource_Titles_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
},
"description": "if provided, returns all language Specified resource titles, if not, all Resource Titles"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/ResourceLocales": {
"get": {
"summary": "Retrieve all Exists Items which belongs to Specified Resource Title ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
]
}
}
}
},
"operationId": "Retrieve_all_Exists_Items_which_belongs_to_Specified_Resource_Title_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "resource",
"in": "query",
"schema": {
"type": "string"
},
"description": "Specified Resource Title"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/Translation": {
"get": {
"summary": "Extract Translation of a Resource in Specified Language ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "Extract_Translation_of_a_Resource_in_Specified_Language_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
},
"description": "Specified Language ..."
},
{
"name": "resource",
"in": "query",
"schema": {
"type": "string"
},
"description": "Specified Resource Title ..."
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/Locale": {
"get": {
"summary": "Retrieve a Resource as Locale Model ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"language": "string",
"value": "string"
}
}
}
}
},
"operationId": "Retrieve_a_Resource_as_Locale_Model_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
},
"description": "Specified Language ..."
},
{
"name": "resource",
"in": "query",
"schema": {
"type": "string"
},
"description": "Specified Resource Title ..."
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/Locales": {
"get": {
"summary": "Retrieve all Exists Resource Instances as Locale Models ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"language": "string",
"value": "string"
}
]
}
}
}
},
"operationId": "Retrieve_all_Exists_Resource_Instances_as_Locale_Models_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "resource",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/GetResource": {
"get": {
"summary": "Retrieve all Locales of Specified Resource and Represent as XResourceDto ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
},
"operationId": "Retrieve_all_Locales_of_Specified_Resource_and_Represent_as_XResourceDto_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "resource",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/AddOrUpdateResource": {
"post": {
"summary": "Add or Update a Resource Model ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
},
"operationId": "Add_or_Update_a_Resource_Model_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/RemoveResource": {
"post": {
"summary": "Remove Specified Resource Model ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Remove_Specified_Resource_Model_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/{id}": {
"get": {
"summary": "Get Specified Item by ID ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
}
}
}
},
"operationId": "Get_Specified_Item_by_ID_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"put": {
"summary": "Update an item values ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
}
}
}
},
"operationId": "Update_an_item_values_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"delete": {
"summary": "Remove an Item ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
}
}
}
},
"operationId": "Remove_an_Item_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider": {
"get": {
"summary": "Get All Exists Items ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
]
}
}
}
},
"operationId": "Get_All_Exists_Items_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"post": {
"summary": "Add an item ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
}
}
}
},
"operationId": "Add_an_item_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/Find/One": {
"get": {
"summary": "Find an item by providing a Conditional Expression ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
}
}
}
},
"operationId": "Find_an_item_by_providing_a_Conditional_Expression_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "query",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/Find/Many": {
"get": {
"summary": "Find a collection of Items by proving a Query Search ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
]
}
}
}
},
"operationId": "Find_a_collection_of_Items_by_proving_a_Query_Search_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "query",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/Query": {
"get": {
"summary": "Retrieve Items based on XQuery Pagination structure ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Items_based_on_XQuery_Pagination_structure_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/Query/Owned": {
"get": {
"summary": "Retrieve Owned Items based on XQuery Pagination structure ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Owned_Items_based_on_XQuery_Pagination_structure_",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_3",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/StringProvider/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_3",
"tags": [
"StringProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/TestFeatures": {
"get": {
"summary": "Untitled Request",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Untitled_Request_3",
"tags": [
"TestFeatures"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/api/TestFeatures/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_4",
"tags": [
"TestFeatures"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/api/TestFeatures/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_4",
"tags": [
"TestFeatures"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/PassReadAccess": {
"get": {
"summary": "API Read Scope",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "API_Read_Scope",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/PassWriteAccess": {
"get": {
"summary": "API Write Scope",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "API_Write_Scope",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/PassAdminAccess": {
"get": {
"summary": "API Admin Scope",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "API_Admin_Scope",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/PassManageAccess": {
"get": {
"summary": "API Manage Scop",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "API_Manage_Scop",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/HiClaims": {
"get": {
"summary": "a simple Action which returns a List of Authenticated User Claims",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "a_simple_Action_which_returns_a_List_of_Authenticated_User_Claims",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/HiUser": {
"get": {
"summary": "a simple Hello User for Checking Authentication and Policy",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "a_simple_Hello_User_for_Checking_Authentication_and_Policy",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/HiEnabledUser": {
"get": {
"summary": "a simple Hello User for Checking Authentication and Policy",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "a_simple_Hello_User_for_Checking_Authentication_and_Policy_2",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/HiAgent": {
"get": {
"summary": "a simple Hello User for Checking Authentication and Policy",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "a_simple_Hello_User_for_Checking_Authentication_and_Policy_3",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/HiEnabledAgent": {
"get": {
"summary": "a simple Hello User for Checking Authentication and Policy",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "a_simple_Hello_User_for_Checking_Authentication_and_Policy_4",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/HiAdmin": {
"get": {
"summary": "a simple Hello User for Checking Authentication and Policy",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "a_simple_Hello_User_for_Checking_Authentication_and_Policy_5",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/HiEnabledAdmin": {
"get": {
"summary": "a simple Hello User for Checking Authentication and Policy",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "a_simple_Hello_User_for_Checking_Authentication_and_Policy_6",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_5",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/TestIdentity/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_5",
"tags": [
"TestIdentity"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
}
]
}
},
"/api/v{version}/XCategoryProvider/Resources/{id}/HasLocale": {
"get": {
"summary": "Check Has Specified Locale or not ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_Has_Specified_Locale_or_not_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Resources/{id}": {
"get": {
"summary": "Load an Item by all of it's Related Translations ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
},
"operationId": "Load_an_Item_by_all_of_its_Related_Translations_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"put": {
"summary": "Update a Category Item for Specified Language ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
},
"operationId": "Update_a_Category_Item_for_Specified_Language_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"delete": {
"summary": "Remove Item for Specified Language ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
},
"operationId": "Remove_Item_for_Specified_Language_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
},
"description": "if null, Remove All"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Resources": {
"post": {
"summary": "Add Category Item for Specified Language ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
},
"operationId": "Add_Category_Item_for_Specified_Language_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Resources/AddResource": {
"post": {
"summary": "Add Category Item for by It's Locales ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
},
"operationId": "Add_Category_Item_for_by_Its_Locales_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Resources/Refresh": {
"post": {
"summary": "Refresh a Resource ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
},
"operationId": "Refresh_a_Resource_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Resources/All": {
"get": {
"summary": "Get All Resources ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
]
}
}
}
},
"operationId": "Get_All_Resources_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Resources/Find/One": {
"get": {
"summary": "Find One Resource ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
},
"operationId": "Find_One_Resource_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Resources/Find/Many": {
"get": {
"summary": "Find Many Resource ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
]
}
}
}
},
"operationId": "Find_Many_Resource_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Resources/Query": {
"get": {
"summary": "Retrieve Resources by Query Pattern ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Resources_by_Query_Pattern_",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_6",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XCategoryProvider/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_6",
"tags": [
"XCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/Stream/ById": {
"get": {
"summary": "Stream Specified File ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Stream_Specified_File_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{name}/Stream/ByName": {
"get": {
"summary": "Stream Specified File ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Stream_Specified_File__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/Download/ById": {
"get": {
"summary": "Download Specified File ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Download_Specified_File_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{name}/Download/ByName": {
"get": {
"summary": "Download Specified File ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Download_Specified_File__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/Upload": {
"post": {
"summary": "Upload Files ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
]
}
}
}
},
"operationId": "Upload_Files_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"files": {
"type": "string",
"example": ""
}
}
}
}
}
}
}
},
"/api/v{version}/XFileProvider": {
"get": {
"summary": "Get All Exists Items ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
]
}
}
}
},
"operationId": "Get_All_Exists_Items__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"post": {
"summary": "Add an item ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
}
}
}
},
"operationId": "Add_an_item__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"delete": {
"summary": "Remove Specified Files ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "Remove_Specified_Files_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "ids",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/Reference/IsProvidedFor": {
"get": {
"summary": "Check an Item Has Reference to Specified ProvideFor and Specified forProvidedId ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_an_Item_Has_Reference_to_Specified_ProvideFor_and_Specified_forProvidedId_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "providedFor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "forProvidedId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/Reference": {
"post": {
"summary": "Add a Reference to Item for Specified ProvideFor and Specified forProvidedId ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Add_a_Reference_to_Item_for_Specified_ProvideFor_and_Specified_forProvidedId_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "providedFor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "forProvidedId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "forIndex",
"in": "query",
"schema": {
"type": "string"
},
"example": "0"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"delete": {
"summary": "Remove a Reference from Item for Specified ProvideFor and Specified forProvidedId ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Remove_a_Reference_from_Item_for_Specified_ProvideFor_and_Specified_forProvidedId_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "providedFor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "forProvidedId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "forIndex",
"in": "query",
"schema": {
"type": "string"
},
"example": "0"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/References": {
"get": {
"summary": "Retrieve References of Specified Itemfor providedFor ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"index": 0,
"referencedTo": "string",
"providedFor": "string"
}
]
}
}
}
},
"operationId": "Retrieve_References_of_Specified_Itemfor_providedFor_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "providedFor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}": {
"get": {
"summary": "Get Specified Item by ID ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
}
}
}
},
"operationId": "Get_Specified_Item_by_ID__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"put": {
"summary": "Update an item values ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
}
}
}
},
"operationId": "Update_an_item_values__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"delete": {
"summary": "Remove an Item ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
}
}
}
},
"operationId": "Remove_an_Item__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/Find/One": {
"get": {
"summary": "Find an item by providing a Conditional Expression ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
}
}
}
},
"operationId": "Find_an_item_by_providing_a_Conditional_Expression__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "query",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/Find/Many": {
"get": {
"summary": "Find a collection of Items by proving a Query Search ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
]
}
}
}
},
"operationId": "Find_a_collection_of_Items_by_proving_a_Query_Search__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "query",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/Query": {
"get": {
"summary": "Retrieve Items based on XQuery Pagination structure ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Items_based_on_XQuery_Pagination_structure__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/Query/Owned": {
"get": {
"summary": "Retrieve Owned Items based on XQuery Pagination structure ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"id": "string",
"deleted": true,
"type": 0,
"name": "string",
"thumb": "string",
"path": "string",
"thumbPath": "string",
"uploadedOn": "string",
"fileName": "string",
"ownerId": "string",
"owner": {
"username": "string",
"firstname": "string",
"lastname": "string",
"avatar": "string"
},
"references": "string"
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Owned_Items_based_on_XQuery_Pagination_structure__2",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/tags/attach": {
"post": {
"summary": "Attach Tag to Specified Item ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Attach_Tag_to_Specified_Item_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/tags/detach": {
"post": {
"summary": "Detach Tag of Specified Item ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Detach_Tag_of_Specified_Item_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/tags/attachs": {
"post": {
"summary": "Attach Tags to Specified Item ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Attach_Tags_to_Specified_Item_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/tags/detachs": {
"post": {
"summary": "Detach Tags of Specified Item ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Detach_Tags_of_Specified_Item_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/{id}/tags": {
"get": {
"summary": "Get Specified Item Tags ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "Get_Specified_Item_Tags_",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_7",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XFileProvider/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_7",
"tags": [
"XFileProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Resources/{id}/HasLocale": {
"get": {
"summary": "Check Has Specified Locale or not ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_Has_Specified_Locale_or_not__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Resources/{id}": {
"get": {
"summary": "Load an Item by all of it's Related Translations ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
}
},
"operationId": "Load_an_Item_by_all_of_its_Related_Translations__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"put": {
"summary": "Update a Category Item for Specified Language ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
}
},
"operationId": "Update_a_Category_Item_for_Specified_Language__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"delete": {
"summary": "Remove Item for Specified Language ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
}
},
"operationId": "Remove_Item_for_Specified_Language__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
},
"description": "if null, Remove All"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Resources": {
"post": {
"summary": "Add Category Item for Specified Language ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
}
},
"operationId": "Add_Category_Item_for_Specified_Language__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "language",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Resources/AddResource": {
"post": {
"summary": "Add Item by it's Locales and Reference ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
}
},
"operationId": "Add_Item_by_its_Locales_and_Reference_",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Resources/Refresh": {
"post": {
"summary": "Refresh a Resource ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
}
},
"operationId": "Refresh_a_Resource__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Resources/All": {
"get": {
"summary": "Get All Resources ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
]
}
}
}
},
"operationId": "Get_All_Resources__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Resources/Find/One": {
"get": {
"summary": "Find One Resource ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
}
}
},
"operationId": "Find_One_Resource__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Resources/Find/Many": {
"get": {
"summary": "Find Many Resource ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
]
}
}
}
},
"operationId": "Find_Many_Resource__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Resources/Query": {
"get": {
"summary": "Retrieve Resources by Query Pattern ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"category": {
"item": {
"id": 0,
"deleted": true,
"title": "string",
"description": "string",
"references": "string"
},
"titles": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
},
"descriptions": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Resources_by_Query_Pattern__2",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_8",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XSubCategoryProvider/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_8",
"tags": [
"XSubCategoryProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTagProvider/{id}": {
"get": {
"summary": "Get Specified Item by ID ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"tag": "string",
"references": "string"
}
}
}
}
},
"operationId": "Get_Specified_Item_by_ID__3",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"put": {
"summary": "Update an item values ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"tag": "string",
"references": "string"
}
}
}
}
},
"operationId": "Update_an_item_values__3",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"delete": {
"summary": "Remove an Item ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"tag": "string",
"references": "string"
}
}
}
}
},
"operationId": "Remove_an_Item__3",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTagProvider": {
"get": {
"summary": "Get All Exists Items ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": 0,
"deleted": true,
"tag": "string",
"references": "string"
}
]
}
}
}
},
"operationId": "Get_All_Exists_Items__3",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"post": {
"summary": "Add an item ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"tag": "string",
"references": "string"
}
}
}
}
},
"operationId": "Add_an_item__3",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTagProvider/Find/One": {
"get": {
"summary": "Find an item by providing a Conditional Expression ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": 0,
"deleted": true,
"tag": "string",
"references": "string"
}
}
}
}
},
"operationId": "Find_an_item_by_providing_a_Conditional_Expression__3",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "query",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTagProvider/Find/Many": {
"get": {
"summary": "Find a collection of Items by proving a Query Search ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": 0,
"deleted": true,
"tag": "string",
"references": "string"
}
]
}
}
}
},
"operationId": "Find_a_collection_of_Items_by_proving_a_Query_Search__3",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "query",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTagProvider/Query": {
"get": {
"summary": "Retrieve Items based on XQuery Pagination structure ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"id": 0,
"deleted": true,
"tag": "string",
"references": "string"
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Items_based_on_XQuery_Pagination_structure__3",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTagProvider/Query/Owned": {
"get": {
"summary": "Retrieve Owned Items based on XQuery Pagination structure ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"id": 0,
"deleted": true,
"tag": "string",
"references": "string"
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Owned_Items_based_on_XQuery_Pagination_structure__3",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTagProvider/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_9",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTagProvider/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_9",
"tags": [
"XTagProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/Languages": {
"get": {
"summary": "Retrieve a List of Exists Languages ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
"string"
]
}
}
}
},
"operationId": "Retrieve_a_List_of_Exists_Languages__2",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/LocalesResource": {
"get": {
"summary": "Retrieve all Exists Items ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": 0,
"deleted": true,
"language": "string",
"resourceTitle": "string",
"translatedValue": "string"
}
]
}
}
}
},
"operationId": "Retrieve_all_Exists_Items_",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/{language}/Translation": {
"get": {
"summary": "Extract Translation of in Specified Language ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": "string"
}
}
}
},
"operationId": "Extract_Translation_of_in_Specified_Language_",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "language",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/{language}/Has": {
"get": {
"summary": "Check Has Specified Translation or not ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": true
}
}
}
},
"operationId": "Check_Has_Specified_Translation_or_not_",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "language",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/{language}/Locale": {
"get": {
"summary": "Retrieve as Locale Model ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"language": "string",
"value": "string"
}
}
}
}
},
"operationId": "Retrieve_as_Locale_Model_",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "language",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/Locales": {
"get": {
"summary": "Retrieve all Exists Locale Models ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"language": "string",
"value": "string"
}
]
}
}
}
},
"operationId": "Retrieve_all_Exists_Locale_Models_",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"post": {
"summary": "Add Or Update Locale ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
},
"operationId": "Add_Or_Update_Locale_",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/Resource": {
"get": {
"summary": "Retrieve as XResourceDto ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
},
"operationId": "Retrieve_as_XResourceDto_",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider": {
"post": {
"summary": "Add or Update a Resource Model ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
},
"operationId": "Add_or_Update_a_Resource_Model__2",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/Locale/Remove": {
"post": {
"summary": "Remove Locale ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"resource": "string",
"locales": [
{
"language": "string",
"value": "string"
}
]
}
}
}
}
},
"operationId": "Remove_Locale_",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/Resource/Remove": {
"post": {
"summary": "Remove Specified Resource Model ...",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Remove_Specified_Resource_Model__2",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_10",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTermsAndConditionsProvider/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_10",
"tags": [
"XTermsAndConditionsProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTestProvider/{id}": {
"get": {
"summary": "Get Specified Item by ID ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"firstname": "string",
"lastname": "string"
}
}
}
}
},
"operationId": "Get_Specified_Item_by_ID__4",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"put": {
"summary": "Update an item values ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"firstname": "string",
"lastname": "string"
}
}
}
}
},
"operationId": "Update_an_item_values__4",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"delete": {
"summary": "Remove an Item ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"firstname": "string",
"lastname": "string"
}
}
}
}
},
"operationId": "Remove_an_Item__4",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTestProvider": {
"get": {
"summary": "Get All Exists Items ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": "string",
"deleted": true,
"firstname": "string",
"lastname": "string"
}
]
}
}
}
},
"operationId": "Get_All_Exists_Items__4",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
},
"post": {
"summary": "Add an item ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"firstname": "string",
"lastname": "string"
}
}
}
}
},
"operationId": "Add_an_item__4",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTestProvider/Find/One": {
"get": {
"summary": "Find an item by providing a Conditional Expression ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"id": "string",
"deleted": true,
"firstname": "string",
"lastname": "string"
}
}
}
}
},
"operationId": "Find_an_item_by_providing_a_Conditional_Expression__4",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "query",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTestProvider/Find/Many": {
"get": {
"summary": "Find a collection of Items by proving a Query Search ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": [
{
"id": "string",
"deleted": true,
"firstname": "string",
"lastname": "string"
}
]
}
}
}
},
"operationId": "Find_a_collection_of_Items_by_proving_a_Query_Search__4",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "query",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTestProvider/Query": {
"get": {
"summary": "Retrieve Items based on XQuery Pagination structure ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"id": "string",
"deleted": true,
"firstname": "string",
"lastname": "string"
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Items_based_on_XQuery_Pagination_structure__4",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTestProvider/Query/Owned": {
"get": {
"summary": "Retrieve Owned Items based on XQuery Pagination structure ...",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"example": {
"items": [
{
"id": "string",
"deleted": true,
"firstname": "string",
"lastname": "string"
}
],
"page": 0,
"pageSize": 0,
"totalPages": 0,
"totalFilteredPages": 0,
"totalFilteredItems": 0,
"totalItems": 0
}
}
}
}
},
"operationId": "Retrieve_Owned_Items_based_on_XQuery_Pagination_structure__4",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "Filter",
"in": "query",
"schema": {
"type": "string"
},
"description": "an string for filtering results"
},
{
"name": "ContainsDetail",
"in": "query",
"schema": {
"type": "string"
},
"description": "determines fully load object with it's relational fields or not"
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string"
},
"description": "specifiy sorting of items"
},
{
"name": "IsAscending",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify sorting direction"
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page number"
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "string"
},
"description": "specify page size"
},
{
"name": "useDefaultOrders",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "useDefaultIncludes",
"in": "query",
"schema": {
"type": "string"
},
"example": "false"
},
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTestProvider/Test/Hi": {
"get": {
"summary": "Check the Controller Up and Running",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_the_Controller_Up_and_Running_11",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
},
"/api/v{version}/XTestProvider/Test/PassRequireXPowered": {
"get": {
"summary": "Check Controller ByPass XPowered Filter",
"responses": {
"200": {
"description": "Success"
}
},
"operationId": "Check_Controller_ByPass_XPowered_Filter_11",
"tags": [
"XTestProvider"
],
"parameters": [
{
"name": "X-PoweredBy",
"in": "header",
"schema": {
"type": "string"
},
"example": "SaherElmITCenter",
"description": "a Basic Authorization Filter"
},
{
"name": "version",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "1.0"
}
]
}
}
},
"servers": [
{
"url": "https://localhost:5001"
}
],
"tags": [
{
"name": "Account"
},
{
"name": "Startup"
},
{
"name": "StringProvider"
},
{
"name": "TestFeatures"
},
{
"name": "TestIdentity"
},
{
"name": "XCategoryProvider"
},
{
"name": "XFileProvider"
},
{
"name": "XSubCategoryProvider"
},
{
"name": "XTagProvider"
},
{
"name": "XTermsAndConditionsProvider"
},
{
"name": "XTestProvider"
}
],
"x-hoppscotch-folder-tags": "slash",
"security": [
{
"apiKey_header_Authorization": []
}
],
"components": {
"securitySchemes": {
"apiKey_header_Authorization": {
"type": "apiKey",
"in": "header",
"name": "Authorization"
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink