Create a Monitoring Subscription
POST/v1/monitoring-subscriptions
Create a Monitoring Subscription
Request​
Header Parameters
Idempotency-Key string
Idempotency key
- application/json
Body
required
- MOD1
- MOD2
oneOf
organisationId stringrequired
validationRequestId stringrequired
Responses​
- 200
- 400
- 401
- 403
Successfully created a Monitoring Subscription
- application/json
- Schema
- Example (from schema)
Schema
data object
id string
organisationId stringnullable
validationRequestId stringnullable
status string
Possible values: [live
, pending_validation_request
, validation_request_failed
, pending
, cancelled
]
configurationId string
results object
complianceStatus stringnullable
Possible values: [pass
, fail
]
registration object
active string
Possible values: [yes
, no
]
warning objectnullable
status string
Possible values: [clear
, flag
]
sanction objectnullable
status string
Possible values: [clear
, flag
]
controversial objectnullable
status string
Possible values: [clear
, flag
]
commercial objectnullable
status string
Possible values: [clear
, flag
]
adverseMedia objectnullable
status string
Possible values: [clear
, flag
]
hateSpeech objectnullable
status string
Possible values: [clear
, flag
]
createdAt date-time
organisation object
name stringnullable
object string
{
"data": {
"id": "monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": "live",
"configurationId": "hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"results": {
"complianceStatus": "fail",
"registration": {
"active": "no"
},
"warning": {
"status": "flag"
},
"sanction": {
"status": "flag"
},
"controversial": {
"status": "flag"
},
"commercial": {
"status": "flag"
},
"adverseMedia": {
"status": "clear"
},
"hateSpeech": {
"status": "flag"
}
},
"createdAt": "2020-10-13T17:46:54.000Z",
"organisation": {
"name": "Name of the organisation the Monitoring Subscription is attached to"
}
},
"object": "monitoring_subscription"
}
Bad request
- application/json
- Schema
- Example (from schema)
- EntityNotFound
- OrganisationNotActive
- BadRequest
- IncorrectParams
- OriginalCallInProgress
- SameKeyDifferentData
- KeyInUse
Schema
error object
code string
title string
message string
reasons string[]nullable
{
"error": {
"code": "string",
"title": "string",
"message": "string",
"reasons": [
"string"
]
}
}
Subscription Entity Not Found
{
"error": {
"code": "monitoring_subscription/entity_not_found",
"title": "Bad request",
"message": "Organisation or validation request was not found"
}
}
400 Bad request
{
"error": {
"code": "monitoring_subscription/organisation_not_active",
"title": "Bad request",
"message": "Organisation is not active"
}
}
400 Bad Request
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "Something is wrong with your request, please check any parameters and try again"
}
}
400 Incorrect Parameters
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "One or more of the inputs were invalid",
"reasons": [
"pageSize must be greater than or equal to 0"
]
}
}
Idempotency - Original call in progress
{
"error": {
"code": "idempotency/original_call_in_progress",
"title": "Bad request",
"message": "Original call with this idempotency key is still in progress"
}
}
Idempotency - Data has changed from previous request
{
"error": {
"code": "idempotency/same_key_different_data",
"title": "Bad request",
"message": "Data has changed from previous request"
}
}
Idempotency - Key in use
{
"error": {
"code": "idempotency/key_already_in_use",
"title": "Bad request",
"message": "Idempotency Key is already in use"
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
code string
title string
message string
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}
Loading...