- Documentation
- Sandbox
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| client_id | string | true | CLIENT_ID | |
| client_secret | string | true | CLIENT_SECRET | |
| grant_type | string | true | Grant type, pattern=(authorization_code|password|client_credentials|refresh_token|SERVER_HOST/grants/api_key) | |
| code | string | false | CODE returned when authorize with Authorization Code | |
| refresh_token | string | false | REFRESH_TOKEN | |
| redirect_uri | string | false | CLIENT_HOST | |
| password | string | false | USERNAME | |
| username | string | false | PASSWORD | |
| api_key | string | false | API_KEY |
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| id |
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| id |
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| id |
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Status Code | Description |
|---|---|
| 200 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fos_user_change_password | object (ChangePasswordFormType) | true | ||
| fos_user_change_password[current_password] | string | true | form.current_password | |
| fos_user_change_password[plainPassword] | object (RepeatedType) | true | ||
| fos_user_change_password[plainPassword][first] | string | true | form.new_password | |
| fos_user_change_password[plainPassword][second] | string | true | form.new_password_confirmation |
| Status Code | Description |
|---|---|
| 200 |
|
| 201 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
Get a ScheduledCommand object with its id and forward it to the index action (view)
| Name | Requirement | Type | Description |
|---|---|---|---|
| scheduledCommandId |
| Status Code | Description |
|---|---|
| 200 |
|
method checks if there are jobs which are enabled but did not return 0 on last execution or are locked.
if a match is found, HTTP status 417 is sent along with an array which contains name, return code and locked-state.
if no matches found, HTTP status 200 is sent with an empty array
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true | ||
| filter[sortByTitle] | string | false |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| id |
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| view |
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| id |
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| _format | string | Response format |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| name | string | true | Filter by name | |
| countryCodes | array | true | Filter by country CODE | |
| partyCodes | array | true | Filter by party CODE | |
| responsibilityCodes | array | true | Filter by responsibility CODE | |
| offset | int | false | Start id | |
| limit | int | false | Limit of response objects |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| id |
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| _format | string | Response format |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| dateTimestamp | string | true | Maximum Date | |
| token | string | true | ||
| offset | int | false | Start id | |
| limit | int | false | Limit of response objects |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| _format | string | Response format |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| token | string | true | subscription token | |
| title | string | true | Title | |
| body | string | true | Body | |
| id | id | true | Id of feed entity |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 500 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| _format | string | Response format |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| category | string | false | Category of feeds court|cambre | |
| id | id | false | Id of entity | |
| token | string | false | Subscription token | |
| filter | string | false | Filter optional when providing token | |
| offset | int | false | Start id | |
| limit | int | false | Limit of response objects |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| token | string |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fos_user_resetting_form[plainPassword][first] | string | true | New password | |
| fos_user_resetting_form[plainPassword][second] | string | true | New password confirmation |
| Status Code | Description |
|---|---|
| 200 |
|
| 201 |
|
| 400 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| id |
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| _format | string | Response format |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| token | string | true | ||
| option | string | true | autosubscribe|cambre|court |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| _format | string | Response format |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| feedId | int | true | Feed id | |
| topicId | int | true | Feed id | |
| token | string | true |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true | ||
| filter[token] | string | false |
| Status Code | Description |
|---|---|
| 200 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| add | object (AddType) | true | ||
| add[token] | string | false | ||
| add[subscriptionType] | string | true | ||
| add[feed] | string | false | ||
| add[topic] | string | false |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| id | \d+ |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| edit | object (EditType) | true | ||
| edit[subscriptionType] | string | true | ||
| edit[token] | string | true |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| _format | string | Response format |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| oldToken | string | false | Old token to be replaced | |
| newToken | string | false | New token to be saved |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 403 |
|
| 404 |
|
| 500 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true | ||
| filter[token] | string | false |
| Status Code | Description |
|---|---|
| 200 |
|
| Name | Information | ||
|---|---|---|---|
| filter[offset] |
|
||
| filter[limit] |
|
||
| filter[orderBy] |
|
||
| filter[order] |
|
||
| filter[count] |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| filter | object (FilterType) | true |
| Status Code | Description |
|---|---|
| 200 |
|
Documentation auto-generated on Wed, 30 Dec 20 06:59:22 +0100