Retrieve push entry

GET /show
Retrieve moh server by it's unique ID.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • id

    integer

    required

    The unique ID of push.

    format : int64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/mobile_push/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • android_sender_id

    string

    android_sender_id.
  • ios_crt_filename

    string

    ios_crt_filename.
  • ios_private_key_filename

    string

    ios_private_key_filename.
  • enabled

    boolean

    enabled.
  • app_name

    string

    app_name.
  • mode

    string

    Push mode: PRODUCTION or DEVELOPMENT.

    enum : ['PRODUCTION', 'DEVELOPMENT']

  • android_server_key

    string

    android_server_key.
  • id

    integer

    app_id.

    format : int64

Sample Response

                      
{}

Destroy push

POST /destroy
Destroy an push entry.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • id

    integer

    required

    app_id.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/mobile_push/destroy \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'

Responses

200
Successful operation
400
Invalid tariff ID supplied.

Sample Response

Update push

POST /update
Update push
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • android_sender_id

    string

    required

    android_sender_id.
  • mode

    string

    required

    Push mode: PRODUCTION or DEVELOPMENT.

    enum : ['PRODUCTION', 'DEVELOPMENT']

  • ios_crt_filename

    string

    required

    ios_crt_filename.
  • ios_private_key_filename

    string

    required

    ios_private_key_filename.
  • enabled

    boolean

    required

    enabled.
  • app_name

    string

    required

    app_name.
  • ios_crt_data

    string

    required

    ios_crt_data.
  • android_server_key

    string

    required

    android_server_key.
  • ios_private_key_data

    string

    required

    ios_private_key_data.
  • id

    integer

    required

    app_id.

    format : int64

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/mobile_push/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'

Responses

200
Successful operation

Sample Response

Create an push entry.

POST /create
Add a new push entry into system.
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

Request body
application/json
  • mode

    string

    required

    Push mode: PRODUCTION or DEVELOPMENT.

    enum : ['PRODUCTION', 'DEVELOPMENT']

  • ios_crt_filename

    string

    required

    ios_crt_filename.
  • ios_private_key_filename

    string

    required

    ios_private_key_filename.
  • app_name

    string

    required

    app_name.
  • enabled

    boolean

    required

    enabled.
  • android_sender_id

    string

    required

    android_sender_id.
  • ios_crt_data

    string

    required

    ios_crt_data.
  • android_server_key

    string

    required

    android_server_key.
  • ios_private_key_data

    string

    required

    ios_private_key_data.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/mobile_push/create \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'

Responses

200
Created push
application/json
  • id

    integer

    app_id.

    format : int64

Sample Response

                      
{}

Retrieve a collection of push

GET /list
Retrieve a collection of push
Path parameters
  • access_token

    string

    required

    token to be passed as a header

    minLength: 64

    maxLength: 64

  • pagination

    integer

    required

    The pagination of paging.

    format : int32

  • pagesize

    integer

    required

    The size of paging.
  • sort_by

    string

    optional

    Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.

    enum : ['DEFAULT', 'OPTIONAL']

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/mobile_push/list \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

200
Successful operation
application/json
  • count

    integer

  • pushs

    array

    Show child attributes
  • sort_by

    string

Sample Response

                      
{
    "count": 100,
    "sort_by": "DEFAULT"
}