API

Catalog


POST Delete app

Request path:

https://oss.aiursoft.com/API/DeleteApp

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&AppId=yourAppId 

Request form:

Name Required Type
AccessToken Required Text
AppId Required Text

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

GET View my buckets

Request path:

https://oss.aiursoft.com/API/ViewMyBucketsTry

Request example:

https://oss.aiursoft.com/API/ViewMyBuckets?AccessToken=yourAccessToken

Request arguments:

Name Required Type
AccessToken Required Text

Possible Response:

{
  "AppId": "an example string.",
  "Buckets": [
    {
      "BucketId": 0,
      "BucketName": "an example string.",
      "OpenToRead": true,
      "OpenToUpload": true,
      "BelongingAppId": "an example string.",
      "FileCount": 0
    }
  ],
  "Code": 0,
  "Message": "an example string."
}

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

POST Create bucket

Request path:

https://oss.aiursoft.com/API/CreateBucket

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&BucketName=yourBucketName&OpenToRead=false&OpenToUpload=false 

Request form:

Name Required Type
AccessToken Required Text
BucketName Required Text
OpenToRead Required Boolean
OpenToUpload Required Boolean

Possible Response:

{
  "BucketId": 0,
  "Code": 0,
  "Message": "an example string."
}

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

POST Edit bucket

Request path:

https://oss.aiursoft.com/API/EditBucket

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&BucketId=0&NewBucketName=yourNewBucketName&OpenToRead=false&OpenToUpload=false 

Request form:

Name Required Type
AccessToken Required Text
BucketId Required Number
NewBucketName Required Text
OpenToRead Required Boolean
OpenToUpload Required Boolean

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

GET View bucket detail

Request path:

https://oss.aiursoft.com/API/ViewBucketDetailTry

Request example:

https://oss.aiursoft.com/API/ViewBucketDetail?BucketId=0

Request arguments:

Name Required Type
BucketId Required Number

Possible Response:

{
  "BucketId": 0,
  "BucketName": "an example string.",
  "OpenToRead": true,
  "OpenToUpload": true,
  "BelongingAppId": "an example string.",
  "FileCount": 0,
  "Code": 0,
  "Message": "an example string."
}

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

POST Delete bucket

Request path:

https://oss.aiursoft.com/API/DeleteBucket

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&BucketId=0 

Request form:

Name Required Type
AccessToken Required Text
BucketId Required Number

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

GET View one file

Request path:

https://oss.aiursoft.com/API/ViewOneFileTry

Request example:

https://oss.aiursoft.com/API/ViewOneFile?FileKey=0

Request arguments:

Name Required Type
FileKey Required Number

Possible Response:

{
  "File": {
    "FileKey": 0,
    "RealFileName": "an example string.",
    "FileExtension": "an example string.",
    "JFileSize": 0,
    "DownloadTimes": 0,
    "BucketId": 0,
    "UploadTime": "2019-08-25T21:00:41.4360205Z",
    "AliveDays": 0,
    "InternetPath": "an example string."
  },
  "Code": 0,
  "Message": "an example string."
}

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

GET View multi files

Request path:

https://oss.aiursoft.com/API/ViewMultiFilesTry

Request example:

https://oss.aiursoft.com/API/ViewMultiFiles?Ids=yourIds

Request arguments:

Name Required Type
Ids Required Text

Possible Response:

{
  "Items": [
    {
      "FileKey": 0,
      "RealFileName": "an example string.",
      "FileExtension": "an example string.",
      "JFileSize": 0,
      "DownloadTimes": 0,
      "BucketId": 0,
      "UploadTime": "2019-08-25T21:00:41.4451669Z",
      "AliveDays": 0,
      "InternetPath": "an example string."
    }
  ],
  "Code": 0,
  "Message": "an example string."
}

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

POST Upload file

Request path:

https://oss.aiursoft.com/API/UploadFile

Request content type:

multipart/form-data

Form content example:

AliveDays=0&AccessToken=yourAccessToken&BucketId=0 

Request form:

Name Required Type
AliveDays Required Number
AccessToken Required Text
BucketId Required Number
File Required File

Possible Response:

{
  "FileKey": 0,
  "Path": "an example string.",
  "Code": 0,
  "Message": "an example string."
}

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

GET View all files

Request path:

https://oss.aiursoft.com/API/ViewAllFilesTry

Request example:

https://oss.aiursoft.com/API/ViewAllFiles?AccessToken=yourAccessToken&BucketId=0

Request arguments:

Name Required Type
AccessToken Required Text
BucketId Required Number

Possible Response:

{
  "BucketId": 0,
  "AllFiles": [
    {
      "FileKey": 0,
      "RealFileName": "an example string.",
      "FileExtension": "an example string.",
      "JFileSize": 0,
      "DownloadTimes": 0,
      "BucketId": 0,
      "UploadTime": "2019-08-25T21:00:41.4458644Z",
      "AliveDays": 0,
      "InternetPath": "an example string."
    }
  ],
  "Code": 0,
  "Message": "an example string."
}

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}

POST Delete file

Request path:

https://oss.aiursoft.com/API/DeleteFile

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&FileKey=0 

Request form:

Name Required Type
AccessToken Required Text
FileKey Required Number

Possible Response:

{
  "Code": -1,
  "Message": "Some error."
}

Possible Response:

{
  "Items": [
    "Some item is invalid!"
  ],
  "Code": -10,
  "Message": "Your input contains several errors!"
}