Records

Catalog


POST Create new record

Request path:

https://warpgate.aiursoft.com/Records/CreateNewRecord

Request example:

https://warpgate.aiursoft.com/Records/CreateNewRecord?AccessToken=yourAccessToken&NewRecordName=yourNewRecordName&Type=yourType&TargetUrl=yourTargetUrl&Enabled=false&Tags=yourTags

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&NewRecordName=yourNewRecordName&Type=yourType&TargetUrl=yourTargetUrl&Enabled=false&Tags=yourTags 

Request form:

Name Required Type
AccessToken Required Text
NewRecordName Required Text
Type Required A magic type!
TargetUrl Required Text
Enabled Required Boolean
Tags Not 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 records

Request path:

https://warpgate.aiursoft.com/Records/ViewMyRecords

Request example:

https://warpgate.aiursoft.com/Records/ViewMyRecords?AccessToken=yourAccessToken&Tag=yourTag

Try

Request arguments:

Name Required Type
AccessToken Required Text
Tag Not required Text

Possible Response:

{
  "appId": "an example string.",
  "records": [
    {
      "id": 0,
      "appId": "an example string.",
      "recordUniqueName": "an example string.",
      "targetUrl": "an example string.",
      "type": 0,
      "creationTime": "2023-06-04T00:22:30.1630639Z",
      "enabled": true,
      "tags": "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 Update record info

Request path:

https://warpgate.aiursoft.com/Records/UpdateRecordInfo

Request example:

https://warpgate.aiursoft.com/Records/UpdateRecordInfo?AccessToken=yourAccessToken&OldRecordName=yourOldRecordName&NewRecordName=yourNewRecordName&NewType=yourNewType&NewUrl=yourNewUrl&Enabled=false&Tags=yourTags

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&OldRecordName=yourOldRecordName&NewRecordName=yourNewRecordName&NewType=yourNewType&NewUrl=yourNewUrl&Enabled=false&Tags=yourTags 

Request form:

Name Required Type
AccessToken Required Text
OldRecordName Required Text
NewRecordName Required Text
NewType Required A magic type!
NewUrl Required Text
Enabled Required Boolean
Tags Not required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Delete record

Request path:

https://warpgate.aiursoft.com/Records/DeleteRecord

Request example:

https://warpgate.aiursoft.com/Records/DeleteRecord?AccessToken=yourAccessToken&RecordName=yourRecordName

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&RecordName=yourRecordName 

Request form:

Name Required Type
AccessToken Required Text
RecordName Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Delete app

Request path:

https://warpgate.aiursoft.com/Records/DeleteApp

Request example:

https://warpgate.aiursoft.com/Records/DeleteApp?AccessToken=yourAccessToken&AppId=yourAppId

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!"
}