API - Administrator

PreviousDevice App Versions NextAPI - Client

Last updated 2 years ago

Was this helpful?

get

Authorizations

Responses

200

Successful Operation

application/json

ResponseanyExample:

{"statusCode":200,"data":{"appVersions":[{"id":"7d484e87-d3ce-4139-ba5d-32c5225f0cc5","device":"ANDROID","version":"1.0.0","createdAt":"2022-12-08 16:13:59.499068"}]}}

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

422

An error occurred while processing the information

application/json

get

GET /admin/device-app-versions/history HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 200,
  "data": {
    "appVersions": [
      {
        "id": "7d484e87-d3ce-4139-ba5d-32c5225f0cc5",
        "device": "ANDROID",
        "version": "1.0.0",
        "createdAt": "2022-12-08 16:13:59.499068"
      }
    ]
  }
}

get

Authorizations

Path parameters

devicestring · enumRequiredPossible values:

Responses

200

Successful Operation

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

404

The information doesn't meet the validations expected.

application/json

422

An error occurred while processing the information

application/json

get

GET /admin/device-app-versions/{device} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 200,
  "data": {
    "id": "7d484e87-d3ce-4139-ba5d-32c5225f0cc5",
    "device": "ANDROID",
    "version": "1.0.0",
    "actionLink": "myActionLinkUrl",
    "iconType": "IMAGE",
    "icon": "myIconUrl",
    "title": "Title 1",
    "AppMessage": "loremp ipsum",
    "createdAt": "2022-12-08 16:13:59.499068"
  }
}

delete

Authorizations

Path parameters

idstringRequired

Responses

200

Successful Operation

application/json

ResponseanyExample: {"statusCode":200}

400

The information doesn't meet the validations expected.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

422

An error occurred while processing the information

application/json

delete

DELETE /admin/device-app-versions/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 200
}

get

Authorizations

Responses

200

Successful Operation

application/json

ResponseanyExample: {"statusCode":200,"data":{"appVersions":[{"device":"ANDROID","version":"1"}]}}

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

422

An error occurred while processing the information

application/json

get

GET /admin/device-app-versions HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "statusCode": 200,
  "data": {
    "appVersions": [
      {
        "device": "ANDROID",
        "version": "1"
      }
    ]
  }
}

post

Authorizations

Body

devicestring · enumRequiredExample: IOSPossible values:

versionstring · 0.0.0RequiredExample: 1.0.0

iconTypestring · enumRequiredExample: IMAGEPossible values:

iconstringRequiredExample: myUrlIcon

titlestringRequiredExample: Title 1

messagestringRequiredExample: loremp ipsum

actionLinkstringRequiredExample: myActionLink

isMinimumVersionbooleanRequiredExample: true

Responses

201

Successful Operation

application/json

ResponseanyExample: {"statusCode":201}

400

The information doesn't meet the validations expected.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

422

An error occurred while processing the information

application/json

post

POST /admin/device-app-versions HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "device": "IOS",
  "version": "1.0.0",
  "iconType": "IMAGE",
  "icon": "myUrlIcon",
  "title": "Title 1",
  "message": "loremp ipsum",
  "actionLink": "myActionLink",
  "isMinimumVersion": true
}

{
  "statusCode": 201
}

patch

Authorizations

Path parameters

idstringRequired

Body

devicestring · enumOptionalExample: IOSPossible values:

versionstring · 0.0.0OptionalExample: 1.0.0

iconstringOptionalExample: myUrlIcon

iconTypestring · enumOptionalExample: IMAGEPossible values:

titlestringOptionalExample: Title 1

messagestringOptionalExample: loremp ipsum

actionLinkstringOptionalExample: myActionLink

isMinimumVersionbooleanOptionalExample: true

Responses

200

Successful Operation

application/json

ResponseanyExample: {"statusCode":200}

400

The information doesn't meet the validations expected.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

403

The token is correct but you need a specific role to access this endpoint

application/json

422

An error occurred while processing the information

application/json

patch

PATCH /admin/device-app-versions/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "device": "IOS",
  "version": "1.0.0",
  "icon": "myUrlIcon",
  "iconType": "IMAGE",
  "title": "Title 1",
  "message": "loremp ipsum",
  "actionLink": "myActionLink",
  "isMinimumVersion": true
}

{
  "statusCode": 200
}