This page is under construction
We’re working on it!

Provider Management
Provider Enrolment Management
Provider Enrolment Sample Management
Provider Enrolment Sample Validation Management
Provider Notification Management
Provider Request Management

1. Provider Management

Set of API endpoints that allow Providers to be viewed or edited.

1.1 GET: List Providers
1.2 GET: Read Provider

1.1 List Providers

API endpoint for listing Providers.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
search	string	A search term.
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer	-
next	string <uri> Nullable	-
previous	string <uri> Nullable	-
results `required`	Array of Objects (Provider)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": "string",
    "instrument": {
      "id": 0,
      "options_schema": {},
      "name": "string",
      "acronym": "string",
      "queue": "string",
      "enabled": true,
      "requires_enrolment": true,
      "description": "string",
      "identity": true,
      "originality": true,
      "authorship": true,
      "integrity": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "name": "string",
    "queue": "string",
    "description": "string",
    "url": "string",
    "version": "string",
    "acronym": "string",
    "allow_validation": true,
    "inverted_polarity": true,
    "image": "string",
    "has_service": true,
    "service_port": -2147483648,
    "options_schema": {},
    "options": {},
    "credentials": "string",
    "enabled": false,
    "validation_active": false
  }
]
}

[top section] [top page]

1.2 Read Provider

Retrieves information about a Provider.

Request

Concept	Data
HTTP method	`GET`
Path	/api/v2/provider/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	integer	Request path parameter. A unique integer value identifying this provider.

Response parameters.

Name	Type	Comments
id	string (ID)	-
instrument	object (Instrument)	-
name `required`	string (Name) [1 .. 250] characters	Provider name.
queue `required`	string (Queue) [1 .. 50] characters	Queue where provider listens for requests.
description	string (Description) Nullable.	Provider description.
url	string (Url name) [1 .. 250 characters] Nullable	Provider url.
version `required`	string (Version) [1 .. 15] characters	Provider version.
acronym `required`	string (Acronym) [1 .. 30] characters	Provider acronym.
allow_validation	boolean (Allow validation)	Whether this provider provides validation feature for data.
inverted_polarity	boolean (Inverted polarity)	If enabled, good values are lower values.
image `required`	string (Image) [1 .. 250] characters	Provider Docker image.
has_service	boolean (Has service)	Whether this provider starts a service and must be balanced.
service_port	integer (service Port) [ -2147483648 .. 2147483647 ] Nullable	Port where service is listening.
options_schema	object (Options schema) Nullable	-
options	object (Options) Nullable	-
credentials	string (Credentials)	-
enabled	boolean (Enabled) Nullable	Default: false
validation_active	boolean (Validation active) Nullable	Default: false

Responses

Response sample: 200

200

{
  "id": "string",
  "instrument": {
    "id": 0,
    "options_schema": {},
    "name": "string",
    "acronym": "string",
    "queue": "string",
    "enabled": true,
    "requires_enrolment": true,
    "description": "string",
    "identity": true,
    "originality": true,
    "authorship": true,
    "integrity": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "name": "string",
  "queue": "string",
  "description": "string",
  "url": "string",
  "version": "string",
  "acronym": "string",
  "allow_validation": true,
  "inverted_polarity": true,
  "image": "string",
  "has_service": true,
  "service_port": -2147483648,
  "options_schema": {},
  "options": {},
  "credentials": "string",
  "enabled": false,
  "validation_active": false
}

[top section] [top page]

2. Provider Enrolment Management

Set of API endpoints that allow Provider access enrolment samples.

2.1 GET: List Provider Enrolment
2.2 POST: Create Provider Enrolment
2.3 GET: Read Provider Enrolment
2.4 PUT: Update Provider Enrolment
2.5 PATCH: Partial Update Provider Enrolment
2.6 DELETE: Delete Provider Enrolment
2.7 GET: Provider Enrolment Available Samples
2.8 POST: Unlock Provider Enrolment
2.9 GET: Provider Enrolment Used Samples

2.1 List Provider Enrolment

API endpoint for listing Provider Enrolment.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_provider_id `required`	string	Request path parameter.
search	string	A search term
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer	-
next	string <uri> Nullable	-
previous	string <uri> Nullable	-
results `required`	Array of objects (ProviderEnrolment)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
    "model": "http://example.com",
    "is_locked": true,
    "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
    "model_upload_url": "string",
    "percentage": 0,
    "can_analyse": false,
    "model_total_samples": 0,
    "used_samples": []
  }
]
}

[top section] [top page]

2.2 Create Provider Enrolment

API endpoint for creating a new Provider Enrolment.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_provider_id `required`	string	Request path parameter.
learner_id `required`	string <uuid> (Learner id)	-
task_id `required`	string <uuid> (Task id)	-
percentage	number (Percentage)	Default: 0
can_analyse	boolean (Can analyse)	Default: false
used_samples	Array of integers Nullable.	Default: []

Response parameters.

Name	Type	Comments
id	integer (ID)	-
learner_id `required`	string <uuid> (Learner id)	-
model	string <uri> (Model)	Default: 0
is_locked	boolean (Is locked)	-
task_id `required`	string <uuid> (Task id)	-
model_upload_url	string (Model upload url)	-
percentage	number (Percentage)	Default: 0
can_analyse	boolean (Can analyse)	Default: false
model_total_samples	integer (Model total samples)	-
used_samples	Array of integers Nullable.	Default: []

Request Sample:

{
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
  "percentage": 0,
  "can_analyse": false,
  "used_samples": []
}

Responses

Response sample

201

{
"id": 0,
"learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
"model": "http://example.com",
"is_locked": true,
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"model_upload_url": "string",
"percentage": 0,
"can_analyse": false,
"model_total_samples": 0,
"used_samples": []
}

[top section] [top page]

2.3 Read Provider Enrolment

Retrieves information about Provider access enrolment samples.

Request

Concept	Data
HTTP method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{learner__learner_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
learner__learner_id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
learner_id `required`	string <uuid> (Learner id)	-
model	string <uri> (Model)	Default: 0
is_locked	boolean (Is locked)	-
task_id `required`	string <uuid> (Task id)	-
model_upload_url	string (Model upload url)	-
percentage	number (Percentage)	Default: 0
can_analyse	boolean (Can analyse)	Default: false
model_total_samples	integer (Model total samples)	-
used_samples	Array of integers Nullable.	Default: []

Responses

Response sample: 200

200

{
  "id": 0,
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "model": "http://example.com",
  "is_locked": true,
  "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
  "model_upload_url": "string",
  "percentage": 0,
  "can_analyse": false,
  "model_total_samples": 0,
  "used_samples": []
}

[top section] [top page]

2.4 Update Provider Enrolment

API endpoint that updates Provider access enrolment samples.

Request

Concept	Data
HTTP method	`PUT`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{learner__learner_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
learner__learner_id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
learner_id `required`	string <uuid> (Learner id)	-
task_id `required`	string <uuid> (Task id)	-
percentage	number (Percentage)	Default: 0
can_analyse	boolean (Can analyse)	Default: false
used_samples	Array of integers Nullable.	Default: []

Request sample

{
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
  "percentage": 0,
  "can_analyse": false,
  "used_samples": []
}

Responses

Response sample: 200

200

{
  "id": 0,
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "model": "http://example.com",
  "is_locked": true,
  "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
  "model_upload_url": "string",
  "percentage": 0,
  "can_analyse": false,
  "model_total_samples": 0,
  "used_samples": []
}

[top section] [top page]

2.5 Partial Update Provider Enrolment

API endpoint that updates Provider access enrolment samples’ information.

Request

Concept	Data
HTTP method	`PATCH`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{learner__learner_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
learner__learner_id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.
learner_id `required`	string <uuid> (Learner id)	-
task_id `required`	string <uuid> (Task id)	-
percentage	number (Percentage)	Default: 0
can_analyse	boolean (Can analyse)	Default: false
used_samples	Array of integers Nullable.	Default: []

Response parameters.

Name	Type	Comments
id	integer (ID)	-
learner_id `required`	string <uuid> (Learner id)	-
model	string <uri> (Model)	-
is_locked	boolean (Is locked)	-/td>
task_id `required`	string <uuid> (Task id)	-
model_upload_url	string (Model upload url)	-
percentage	number (Percentage)	Default: 0
can_analyse	boolean (Can analyse)	Default: false
model_total_samples	integer (Model total samples)	-
used_samples	Array of integers Nullable.	Default: []

Request sample

{
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
  "percentage": 0,
  "can_analyse": false,
  "used_samples": []
}

Responses

Response sample: 200

200

{
  "id": 0,
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "model": "http://example.com",
  "is_locked": true,
  "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
  "model_upload_url": "string",
  "percentage": 0,
  "can_analyse": false,
  "model_total_samples": 0,
  "used_samples": []
}

[top section] [top page]

2.6 Delete Provider Enrolment

API endpoint for deleting Provider access enrolment samples.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{learner__learner_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
learner__learner_id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.

Responses

Response sample: 204

204

{
}

[top section] [top page]

2.7 Provider Enrolment Available Samples

Get available samples for this enrolment model.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{learner__learner_id}/available_samples/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
learner__learner_id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
learner_id	string <uuid> (Learner id)	-
data	string <uri> (Data)	-

Responses

Response sample: 200

200

{
  "id": 0,
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "data": "http://example.com"
}

[top section] [top page]

2.8 Unlock Provider Enrolment

API endpoint for unlocking a locked model.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{learner__learner_id}/unlock/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
learner__learner_id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
learner_id	string <uuid> (Learner id)	-
data	string <uri> (Data)	-

Responses

Response sample: 201

201

{
  "id": 0,
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "data": "http://example.com"
}

[top section] [top page]

2.9 Provider Enrolment Used Samples

Get used samples for this enrolment model.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{learner__learner_id}/used_samples/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
learner__learner_id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
learner_id	string <uuid> (Learner id)	-
data	string <uri> (Data)	-

Responses

Response sample: 200

200

{
  "id": 0,
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "data": "http://example.com"
}

[top section] [top page]

3. Provider Enrolment Sample Management

Set of API endpoints that allow Provider access enrolment samples to be viewed.

3.1 GET: List Providers Enrolment Sample
3.2 GET: Read Provider Enrolment Sample

3.1 List Providers Enrolment Sample

API endpoint for listing Provider Samples.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/{parent_lookup_instruments__provider__id}/enrolment/{parent_lookup_learner__learner_id}/sample/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_instruments__provider__id `required`	string	Request path parameter.
parent_lookup_learner__learner_id `required`	string	Request path parameter.
search	string	A search term.
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer	-
next	string <uri> Nullable	-
previous	string <uri> Nullable	-
results `required`	Array of Objects (Provider)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
    "data": "http://example.com"
  }
]
}

[top section] [top page]

3.2 Read Provider Enrolment Sample

Retrieves information about Provider access enrolment samples.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/{parent_lookup_instruments__provider__id}/enrolment/{parent_lookup_learner__learner_id}/sample/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	integer	Request path parameter. A unique integer value identifying this enrolment sample.
parent_lookup_instruments__provider__id `required`	string	Request path parameter.
parent_lookup_learner__learner_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	string (ID)	-
learner_id	string <uuid> (Learner id)	-
data	string <uuid> (Data)	-

Responses

Response sample: 200

200

{
  "id": 0,
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "data": "http://example.com"
}

[top section] [top page]

4. Provider Enrolment Sample Validation Management

Set of API endpoints that allows Provider manage enrolment sample validation.
4.1 GET: List Provider Enrolment Sample Validation
4.2 POST: Create Provider Enrolment Sample Validation
4.3 GET: Read Provider Enrolment Sample Validation
4.4 PUT: Update Provider Enrolment Sample Validation
4.5 PATCH: Partial Update Provider Enrolment Sample Validation Information
4.6 DELETE: Delete Provider Enrolment Sample Validation
4.7 POST: Status Provider Enrolment Sample Validation

4.1 List Provider Enrolment Sample Validation

API endpoint for listing all Provider manage enrolment sample validation.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{parent_lookup_sample__learner__learner_id}/sample/{parent_lookup_sample_id}/validation/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_provider_id `required`	string	Request path parameter.
parent_lookup_sample__learner__learner_id `required`	string	Request path parameter.
parent_lookup_sample_id `required`	string	Request path parameter.
search	string	A search term.
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer	-
next	string <uri> Nullable	-
previous	string <uri> Nullable	-
results `required`	Array of Objects (Provider)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "status": 0,
    "info": "http://example.com",
    "validation_info": {},
    "provider": 0,
    "sample": {
      "id": 0,
      "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
      "data": "http://example.com"
    },
    "error_message": "string",
    "contribution": 0,
    "message_code_id": "string"
  }
]
}

[top section] [top page]

4.2 Create Provider Enrolment Sample Validation

API endpoint for creating new Provider Enrolment Sample Validation.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{parent_lookup_sample__learner__learner_id}/sample/{parent_lookup_sample_id}/validation/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_provider_id `required`	string	Request path parameter.
parent_lookup_sample__learner__learner_id `required`	string	Request path parameter.
parent_lookup_sample_id `required`	string	Request path parameter.
status	integer (Status) Enum: 0, 1, 2, 3, 4	Validation status for this sample.
validation_info	object (Validation info) Nullable	-
sample	object (ProviderEnrolmentSample)	-
error_message	string (Error message) non-empty Nullable	Error message when status is error.
contribution	number (Contribution) Nullable.	-
requires_enrolment	boolean (Requires enrolment)	Whether this instrument requires enrolment.
message_code_id	string (Message code id) non-empty Nullable.	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
status	integer (Status) Enum: 0, 1, 2, 3, 4	Validation status for this sample.
info	string <uri> (Info) Nullable.	-
validation_info	object (Validation info) Nullable	-
provider	integer (Provider)	-
sample	object (ProviderEnrolmentSample)	-
error_message	string (Error message) non-empty Nullable	Error message when status is error.
contribution	number (Contribution) Nullable.	-
message_code_id	string (Message code id) non-empty Nullable.	-

Request Sample:

{
  "status": 0,
  "validation_info": {},
  "sample": {},
  "error_message": "string",
  "contribution": 0,
  "message_code_id": "string"
}

Responses

Response sample

201

{
"id": 0,
"status": 0,
"info": "http://example.com",
"validation_info": {},
"provider": 0,
"sample": {
  "id": 0,
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "data": "http://example.com"
},
"error_message": "string",
"contribution": 0,
"message_code_id": "string"
}

[top section] [top page]

4.3 Read Provider Enrolment Sample Validation

API endpoint that allows Provider Enrolment Sample Validation information.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{parent_lookup_sample__learner__learner_id}/sample/{parent_lookup_sample_id}/validation/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter. A unique integer value identifying this enrolment sample validation.
parent_lookup_provider_id `required`	string	Request path parameter.
parent_lookup_sample__learner__learner_id `required`	string	Request path parameter.
parent_lookup_sample_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
status	integer (Status) Enum: 0, 1, 2, 3, 4	Validation status for this sample.
info	string <uri> (Info) Nullable.	-
validation_info	object (Validation info) Nullable	-
provider	integer (Provider)	-
sample	object (ProviderEnrolmentSample)	-
error_message	string (Error message) non-empty Nullable	Error message when status is error.
contribution	number (Contribution) Nullable.	-
message_code_id	string (Message code id) non-empty Nullable.	-

Responses

Response sample: 200

200

{
  "id": 0,
  "status": 0,
  "info": "http://example.com",
  "validation_info": {},
  "provider": 0,
  "sample": {
    "id": 0,
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
    "data": "http://example.com"
  },
  "error_message": "string",
  "contribution": 0,
  "message_code_id": "string"
}

[top section] [top page]

4.4 Update Provider Enrolment Sample Validation

API endpoint that allows Provider manage enrolment sample validation updates.

Request

Concept	Data
HTTP Method	`PUT`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{parent_lookup_sample__learner__learner_id}/sample/{parent_lookup_sample_id}/validation/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter. A unique integer value identifying this enrolment sample validation.
parent_lookup_provider_id `required`	string	Request path parameter.
parent_lookup_sample__learner__learner_id `required`	string	Request path parameter.
parent_lookup_sample_id `required`	string	Request path parameter.
status	integer (Status) Enum: 0, 1, 2, 3, 4	Validation status for this sample.
validation_info	object (Validation info) Nullable	-
sample	object (ProviderEnrolmentSample)	-
error_message	string (Error message) non-empty Nullable	Error message when status is error.
contribution	number (Contribution) Nullable.	-
message_code_id	string (Message code id) non-empty Nullable.	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
status	integer (Status) Enum: 0, 1, 2, 3, 4	Validation status for this sample.
info	string <uri> (Info) Nullable.	-
validation_info	object (Validation info) Nullable	-
provider	integer (Provider)	-
sample	object (ProviderEnrolmentSample)	-
error_message	string (Error message) non-empty Nullable	Error message when status is error.
contribution	number (Contribution) Nullable.	-
message_code_id	string (Message code id) non-empty Nullable.	-

Request sample

{
  "status": 0,
  "validation_info": {},
  "sample": {},
  "error_message": "string",
  "contribution": 0,
  "message_code_id": "string"
}

Responses

Response sample: 200

200

{
  "id": 0,
  "status": 0,
  "info": "http://example.com",
  "validation_info": {},
  "provider": 0,
  "sample": {
    "id": 0,
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
    "data": "http://example.com"
  },
  "error_message": "string",
  "contribution": 0,
  "message_code_id": "string"
}

[top section] [top page]

4.5 Partial Update Provider Enrolment Sample Validation Information

API endpoint that updates Provider manage enrolment sample validation.

Request

Concept	Data
HTTP Method	`PATCH`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{parent_lookup_sample__learner__learner_id}/sample/{parent_lookup_sample_id}/validation/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter. A unique integer value identifying this enrolment sample validation.
parent_lookup_provider_id `required`	string	Request path parameter.
parent_lookup_sample__learner__learner_id `required`	string	Request path parameter.
parent_lookup_sample_id `required`	string	Request path parameter.
status	integer (Status) Enum: 0, 1, 2, 3, 4	Validation status for this sample.
validation_info	object (Validation info) Nullable	-
sample	object (ProviderEnrolmentSample)	-
error_message	string (Error message) non-empty Nullable	Error message when status is error.
contribution	number (Contribution) Nullable.	-
message_code_id	string (Message code id) non-empty Nullable.	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
status	integer (Status) Enum: 0, 1, 2, 3, 4	Validation status for this sample.
info	string <uri> (Info) Nullable.	-
validation_info	object (Validation info) Nullable	-
provider	integer (Provider)	-
sample	object (ProviderEnrolmentSample)	-
error_message	string (Error message) non-empty Nullable	Error message when status is error.
contribution	number (Contribution) Nullable.	-
message_code_id	string (Message code id) non-empty Nullable.	-

Request sample

{
  "status": 0,
  "validation_info": {},
  "sample": {},
  "error_message": "string",
  "contribution": 0,
  "message_code_id": "string"
}

Responses

Response sample: 200

200

{
  "id": 0,
  "status": 0,
  "info": "http://example.com",
  "validation_info": {},
  "provider": 0,
  "sample": {
    "id": 0,
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
    "data": "http://example.com"
  },
  "error_message": "string",
  "contribution": 0,
  "message_code_id": "string"
}

[top section] [top page]

4.6 Delete Provider Enrolment Sample Validation

API endpoint for deleting Provider Enrolment Sample Validation.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{parent_lookup_sample__learner__learner_id}/sample/{parent_lookup_sample_id}/validation/{id}/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter. A unique integer value identifying this enrolment sample validation.
parent_lookup_provider_id `required`	string	Request path parameter.
parent_lookup_sample__learner__learner_id `required`	string	Request path parameter.
parent_lookup_sample_id `required`	string	Request path parameter.

Responses

Response sample: 204

204

{
}

[top section] [top page]

4.7 Status Provider Enrolment Sample Validation

Change enrolment sample validation status.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/provider/{parent_lookup_provider_id}/enrolment/{parent_lookup_sample__learner__learner_id}/sample/{parent_lookup_sample_id}/validation/{id}/status/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter. A unique integer value identifying this enrolment sample validation.
parent_lookup_provider_id `required`	string	Request path parameter.
parent_lookup_sample__learner__learner_id `required`	string	Request path parameter.
parent_lookup_sample_id `required`	string	Request path parameter.
status	integer (Status) Enum: 0, 1, 2, 3, 4	Validation status for this sample.
validation_info	object (Validation info) Nullable	-
sample	object (ProviderEnrolmentSample)	-
error_message	string (Error message) non-empty Nullable	Error message when status is error.
contribution	number (Contribution) Nullable.	-
message_code_id	string (Message code id) non-empty Nullable.	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
status	integer (Status) Enum: 0, 1, 2, 3, 4	Validation status for this sample.
info	string <uri> (Info) Nullable.	-
validation_info	object (Validation info) Nullable	-
provider	integer (Provider)	-
sample	object (ProviderEnrolmentSample)	-
error_message	string (Error message) non-empty Nullable	Error message when status is error.
contribution	number (Contribution) Nullable.	-
message_code_id	string (Message code id) non-empty Nullable.	-

Request sample

{
  "status": 0,
  "validation_info": {},
  "sample": {},
  "error_message": "string",
  "contribution": 0,
  "message_code_id": "string"
}

Responses

Response sample: 201

201

{
  "id": 0,
  "status": 0,
  "info": "http://example.com",
  "validation_info": {},
  "provider": 0,
  "sample": {
    "id": 0,
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
    "data": "http://example.com"
  },
  "error_message": "string",
  "contribution": 0,
  "message_code_id": "string"
}

[top section] [top page]

5. Provider Notification Management

Set of API endpoints that allow Provider Notification to be viewed or edited.

5.1 GET: List Provider Notification
5.2 POST: Create Provider Notification
5.3 GET: Read Provider Notification
5.4 PUT: Update Provider Notification
5.5 PATCH: Partial Update Provider Notification
5.6 DELETE: Delete Provider Notification

5.1 List Provider Notification

API endpoint for listing Provider Notification.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/notification/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_provider_id `required`	string	Request path parameter.
search	string	A search term
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer (ID)	-
next	string (uri) Nullable	-
previous	string (uri) Nullable	-
results `required`	Array of objects (ProviderNotification)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "info": {},
    "provider": 0,
    "key": "string",
    "when": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]
}

[top section] [top page]

5.2 Create Provider Notification

API endpoint for creating a new Provider Notification.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/provider/{parent_lookup_provider_id}/notification/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_provider_id `required`	string	Request path parameter.
info	object (Info) Nullable	-
key `required`	string (Key) [1 .. 250] characters	Notification unique key for the provider.
when `required`	string <date-time> (When)	When the notification should be sent to provider.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
info	object (Info) Nullable	-
provider	integer (Provider)	-
key `required`	string (Key) [1 .. 250] characters	Notification unique key for the provider.
when `required`	string <date-time> (When)	When the notification should be sent to provider.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request Sample:

{
  "info": {},
  "key": "string",
  "when": "2019-08-24T14:15:22Z"
}

Responses

Response sample

201

{
"id": 0,
"info": {},
"provider": 0,
"key": "string",
"when": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.3 Read Provider Notification

Retrieves information about Provider Notification.

Request

Concept	Data
HTTP method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/notification/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
info	object (Info) Nullable	-
provider	integer (Provider)	-
key `required`	string (Key) [1 .. 250] characters	Notification unique key for the provider.
when `required`	string <date-time> (When)	When the notification should be sent to provider.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Responses

Response sample: 200

200

{
  "id": 0,
  "info": {},
  "provider": 0,
  "key": "string",
  "when": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.4 Update Provider Notification

API endpoint that updates Provider Notification.

Request

Concept	Data
HTTP method	`PUT`
Path	/api/v2/provider/{parent_lookup_provider_id}/notification/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.
info	object (Info) Nullable	-
key `required`	string (Key) [1 .. 250] characters	Notification unique key for the provider.
when `required`	string <date-time> (When)	When the notification should be sent to provider.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
info	object (Info) Nullable	-
provider	integer (Provider)	-
key `required`	string (Key) [1 .. 250] characters	Notification unique key for the provider.
when `required`	string <date-time> (When)	When the notification should be sent to provider.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "info": {},
  "key": "string",
  "when": "2019-08-24T14:15:22Z"
}

Responses

Response sample: 200

200

{
  "id": 0,
  "info": {},
  "provider": 0,
  "key": "string",
  "when": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.5 Partial Update Provider Notification

API endpoint that updates Provider Notification partial information.

Request

Concept	Data
HTTP method	`PATCH`
Path	/api/v2/provider/{parent_lookup_provider_id}/notification/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.
info	object (Info) Nullable	-
key `required`	string (Key) [1 .. 250] characters	Notification unique key for the provider.
when `required`	string <date-time> (When)	When the notification should be sent to provider.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
info	object (Info) Nullable	-
provider	integer (Provider)	-
key `required`	string (Key) [1 .. 250] characters	Notification unique key for the provider.
when `required`	string <date-time> (When)	When the notification should be sent to provider.
created_at	string <date-time> (Created at)	-
updated_at	string <date-time> (Updated at)	-

Request sample

{
  "info": {},
  "key": "string",
  "when": "2019-08-24T14:15:22Z"
}

Responses

Response sample: 200

200

{
  "id": 0,
  "info": {},
  "provider": 0,
  "key": "string",
  "when": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

[top section] [top page]

5.6 Delete Provider Notification

API endpoint for deleting Provider Notification.

Request

Concept	Data
HTTP Method	`DELETE`
Path	/api/v2/provider/{parent_lookup_provider_id}/notification/{id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
id `required`	string	Request path parameter.
parent_lookup_provider_id `required`	string	Request path parameter.

Responses

Response sample: 204

204

{
}

[top section] [top page]

6. Provider Request Management

Set of API endpoints that allows activity to be viewed or edited.

6.1 GET: List Provider Request
6.2 GET: Read Provider Request
6.3 PUT: Update Provider Request
6.4 PATCH: Partial Update Provider Request
6.5 POST: Status Provider Request

6.1 List Provider Request

API endpoint for listing Provider Requests.

Request

Concept	Data
HTTP Method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/request/
Authorization	JWT
Content Type	application/json

Parameters

Request parameters.

Name	Type	Comments
parent_lookup_provider_id `required`	string	Request path parameter.
search	string	A search term
ordering	string	Which field to use when ordering the results.
limit	integer	Number of results to return per page.
offset	integer	The initial index from which to return the results.

Response parameters.

Name	Type	Comments
count `required`	integer (ID)	-
next	string (uri) Nullable	-
previous	string (uri) Nullable	-
results `required`	Array of objects (ProviderVerificationRequestResult)	-

Responses

Response sample

200

{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
  {
    "id": 0,
    "request": {
      "id": 0,
      "data": "http://example.com"
    },
    "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
    "result": 0,
    "status": 0,
    "error_message": "string",
    "code": 0,
    "audit": "http://example.com",
    "audit_data": {}
  }
]
}

[top section] [top page]

6.2 Read Provider Request

Retrieves information about Provider Request.

Request

Concept	Data
HTTP method	`GET`
Path	/api/v2/provider/{parent_lookup_provider_id}/request/{request_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
request_id `required`	string	Request path parameter. Request related to this result.
parent_lookup_provider_id `required`	string	Request path parameter.

Response parameters.

Name	Type	Comments
id	integer (ID)	-
request	object (ProviderVerificationRequest)	-
learner_id	string <uuid> (Learner id)	-
result	number (Result) Nullable.	Normalized result value.
status	integer (Status) Enum: 0, 1, 2, 3, 4, 5, 6, 7	Status for this result.
error_message	string (Error message) non-empty Nullable	Error message when status is error.
code	integer (Code) Enum: 0, 1, 2, 3	Result code provided after performing the verification process.
audit	string <uri> (Audit)	-
audit_data	object (Audit data) Nullable	-

Responses

Response sample: 200

200

{
  "id": 0,
  "request": {
    "id": 0,
    "data": "http://example.com"
  },
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "result": 0,
  "status": 0,
  "error_message": "string",
  "code": 0,
  "audit": "http://example.com",
  "audit_data": {}
}

[top section] [top page]

6.3 Update Provider Request

API endpoint that updates Provider Request.

Request

Concept	Data
HTTP method	`PUT`
Path	/api/v2/provider/{parent_lookup_provider_id}/request/{request_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
request_id `required`	string	Request path parameter. Request related to this result.
parent_lookup_provider_id `required`	string	Request path parameter.
request	object (ProviderVerificationRequest)	-
result	number (Result) Nullable.	Normalized result value.
status	integer (Status) Enum: 0, 1, 2, 3, 4, 5, 6, 7	Status for this result.
error_message	string (Error message) non-empty Nullable	Error message when status is error.
code	integer (Code) Enum: 0, 1, 2, 3	Result code provided after performing the verification process.
audit_data	object (Audit data) Nullable	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
request	object (ProviderVerificationRequest)	-
learner_id	string <uuid> (Learner id)	-
result	number (Result) Nullable.	Normalized result value.
status	integer (Status) Enum: 0, 1, 2, 3, 4, 5, 6, 7	Status for this result.
error_message	string (Error message) non-empty Nullable	Error message when status is error.
code	integer (Code) Enum: 0, 1, 2, 3	Result code provided after performing the verification process.
audit	string <uri> (Audit)	-
audit_data	object (Audit data) Nullable	-

Request sample

{
  "request": {},
  "result": 0,
  "status": 0,
  "error_message": "string",
  "code": 0,
  "audit_data": {}
}

Responses

Response sample: 200

200

{
  "id": 0,
  "request": {
    "id": 0,
    "data": "http://example.com"
  },
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "result": 0,
  "status": 0,
  "error_message": "string",
  "code": 0,
  "audit": "http://example.com",
  "audit_data": {}
}

[top section] [top page]

6.4 Partial Update Provider Request

API endpoint that updates Provider Request partial information.

Request

Concept	Data
HTTP method	`PATCH`
Path	/api/v2/provider/{parent_lookup_provider_id}/request/{request_id}/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
request_id `required`	string	Request path parameter. Request related to this result.
parent_lookup_provider_id `required`	string	Request path parameter.
request	object (ProviderVerificationRequest)	-
result	number (Result) Nullable.	Normalized result value.
status	integer (Status) Enum: 0, 1, 2, 3, 4, 5, 6, 7	Status for this result.
error_message	string (Error message) non-empty Nullable	Error message when status is error.
code	integer (Code) Enum: 0, 1, 2, 3	Result code provided after performing the verification process.
audit_data	object (Audit data) Nullable	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
request	object (ProviderVerificationRequest)	-
learner_id	string <uuid> (Learner id)	-
result	number (Result) Nullable.	Normalized result value.
status	integer (Status) Enum: 0, 1, 2, 3, 4, 5, 6, 7	Status for this result.
error_message	string (Error message) non-empty Nullable	Error message when status is error.
code	integer (Code) Enum: 0, 1, 2, 3	Result code provided after performing the verification process.
audit	string <uri> (Audit)	-
audit_data	object (Audit data) Nullable	-

Request sample

{
  "request": {},
  "result": 0,
  "status": 0,
  "error_message": "string",
  "code": 0,
  "audit_data": {}
}

Responses

Response sample: 200

200

{
  "id": 0,
  "request": {
    "id": 0,
    "data": "http://example.com"
  },
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "result": 0,
  "status": 0,
  "error_message": "string",
  "code": 0,
  "audit": "http://example.com",
  "audit_data": {}
}

[top section] [top page]

6.5 Status Provider Request

Change Provider Request status.

Request

Concept	Data
HTTP Method	`POST`
Path	/api/v2/provider/{parent_lookup_provider_id}/request/{request_id}/status/
Authorization	JWT
Content Type	application/json

Parameters:

Request parameters.

Name	Type	Comments
request_id `required`	string	Request path parameter. Request related to this result.
parent_lookup_provider_id `required`	string	Request path parameter.
request	object (ProviderVerificationRequest)	-
result	number (Result) Nullable.	Normalized result value.
status	integer (Status) Enum: 0, 1, 2, 3, 4, 5, 6, 7	Status for this result.
error_message	string (Error message) non-empty Nullable	Error message when status is error.
code	integer (Code) Enum: 0, 1, 2, 3	Result code provided after performing the verification process.
audit_data	object (Audit data) Nullable	-

Response parameters.

Name	Type	Comments
id	integer (ID)	-
request	object (ProviderVerificationRequest)	-
learner_id	string <uuid> (Learner id)	-
result	number (Result) Nullable.	Normalized result value.
status	integer (Status) Enum: 0, 1, 2, 3, 4, 5, 6, 7	Status for this result.
error_message	string (Error message) non-empty Nullable	Error message when status is error.
code	integer (Code) Enum: 0, 1, 2, 3	Result code provided after performing the verification process.
audit	string <uri> (Audit)	-
audit_data	object (Audit data) Nullable	-

Request sample:

{
  "request": {},
  "result": 0,
  "status": 0,
  "error_message": "string",
  "code": 0,
  "audit_data": {}
}

Responses

Response sample: 201

201

{
  "id": 0,
  "request": {
    "id": 0,
    "data": "http://example.com"
  },
  "learner_id": "2df776db-09df-4cb9-a2af-db56cada6cb7",
  "result": 0,
  "status": 0,
  "error_message": "string",
  "code": 0,
  "audit": "http://example.com",
  "audit_data": {}
}

[top section] [top page]

Provider

Table of Contents

1. Provider Management

1.1 List Providers

Request

Parameters

Responses

Response sample

1.2 Read Provider

Request

Parameters:

Responses

Response sample: 200

2. Provider Enrolment Management

2.1 List Provider Enrolment

Request

Parameters

Responses

Response sample

2.2 Create Provider Enrolment

Request

Parameters

Request Sample:

Responses

Response sample

2.3 Read Provider Enrolment

Request

Parameters:

Responses

Response sample: 200

2.4 Update Provider Enrolment

Request

Parameters:

Request sample

Responses

Response sample: 200

2.5 Partial Update Provider Enrolment

Request

Parameters:

Request sample

Responses

Response sample: 200

2.6 Delete Provider Enrolment

Request

Parameters:

Responses

Response sample: 204

2.7 Provider Enrolment Available Samples

Request

Parameters:

Responses

Response sample: 200

2.8 Unlock Provider Enrolment

Request

Parameters:

Responses

Response sample: 201

2.9 Provider Enrolment Used Samples

Request

Parameters:

Responses

Response sample: 200

3. Provider Enrolment Sample Management

3.1 List Providers Enrolment Sample

Request

Parameters

Responses

Response sample

3.2 Read Provider Enrolment Sample

Request

Parameters:

Responses

Response sample: 200

4. Provider Enrolment Sample Validation Management

4.1 List Provider Enrolment Sample Validation

Request

Parameters

Responses

Response sample

4.2 Create Provider Enrolment Sample Validation