Register

Get all the clients registered to FOTA service

Request
query Parameters
limit
integer

Number of results to return per page

offset
integer

The initial index from which to return the results

client_name
string

Name of the registered client

client_url
string

URL of the registered client

Responses
200

List of clients registered in the FOTA service

get/api/v0/register/
Response samples
application/json
{
  • "count": 0,
  • "previous": "string",
  • "next": "string",
  • "results": [
    ]
}

Register a client to the FOTA service

Request
Request Body schema: application/json
client_name
required
string
client_url
required
string
Responses
201

Client registration to FOTA succesful

400

Client registration error

401

Client registration error

post/api/v0/register/
Request samples
application/json
{
  • "client_name": "string",
  • "client_url": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "client_name": "string",
  • "client_url": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Get registration details for client

Request
path Parameters
register_id
required
string

ID of registartion

Responses
200

Client registration information

get/api/v0/register/{register_id}/
Response samples
application/json
{
  • "id": "string",
  • "client_name": "string",
  • "client_url": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Update client registration details

Request
path Parameters
register_id
required
string

A UUID string identifying this register client

Request Body schema: application/json
client_name
required
string
client_url
required
string
Responses
200

Client registration update succesful

400

Client registration update error

401

Client registration update error

put/api/v0/register/{register_id}/
Request samples
application/json
{
  • "client_name": "string",
  • "client_url": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "client_name": "string",
  • "client_url": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Partial update client registration details

Request
path Parameters
register_id
required
string

A UUID string identifying this register client

Request Body schema: application/json
client_name
required
string
client_url
required
string
Responses
200

Client registration update succesful

400

Client registration update error

401

Client registration update error

patch/api/v0/register/{register_id}/
Request samples
application/json
{
  • "client_name": "string",
  • "client_url": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "client_name": "string",
  • "client_url": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Delete client registration

Request
path Parameters
register_id
required
string

A UUID string identifying this register client

Responses
200

Registered client deleted successfully

401

Registered client delete error

delete/api/v0/register/{register_id}/