DefendantLegalProceedingsApi v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Email: Iberinform Web: Iberinform
Authentication
-
API Key (ClientSecretHeader)
- Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract
-
API Key (APIKeyHeader)
- Parameter Name: X-IBM-Client-Id, in: header.
Default
get__incidents_{organisationID}_defendant_legalProceedings
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/modules/incidents/{organisationID}/defendant/legalProceedings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/modules/incidents/{organisationID}/defendant/legalProceedings', headers = headers)
print(r.json())
GET https://$(catalog.host)/modules/incidents/{organisationID}/defendant/legalProceedings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/modules/incidents/{organisationID}/defendant/legalProceedings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /incidents/{organisationID}/defendant/legalProceedings
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
organisationID | path | string | true | identificador de la firma |
language | query | string | false | Idioma generación |
Example responses
200 Response
"{"code":"string","message":"string","principal":"string","status":0}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | ErrorDetail |
401 | Unauthorized | Unauthorized | DefLegProcDetails |
403 | Forbidden | Forbidden | DefLegProcDetails |
404 | Not Found | Recurso no encontrado | DefLegProcDetails |
500 | Internal Server Error | Internal error | DefLegProcDetails |
get__incidents_{organisationID}defendant_legalProceedings{incidentID}
Code samples
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'X-IBM-Client-Id' => 'API_KEY',
'X-IBM-Client-Secret' => 'API_KEY'
}
result = RestClient.get 'https://$(catalog.host)/modules/incidents/{organisationID}/defendant/legalProceedings/{incidentID}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'X-IBM-Client-Id': 'API_KEY',
'X-IBM-Client-Secret': 'API_KEY'
}
r = requests.get('https://$(catalog.host)/modules/incidents/{organisationID}/defendant/legalProceedings/{incidentID}', headers = headers)
print(r.json())
GET https://$(catalog.host)/modules/incidents/{organisationID}/defendant/legalProceedings/{incidentID} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'X-IBM-Client-Id':'API_KEY',
'X-IBM-Client-Secret':'API_KEY'
};
fetch('https://$(catalog.host)/modules/incidents/{organisationID}/defendant/legalProceedings/{incidentID}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET /incidents/{organisationID}/defendant/legalProceedings/{incidentID}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
organisationID | path | string | true | identificador de la firma |
language | query | string | false | Idioma generación |
incidentID | path | string | true | none |
Example responses
200 Response
"{"code":"string","message":"string","principal":"string","status":0}"
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 200 OK | ErrorDetail |
401 | Unauthorized | Unauthorized | DefLegProcIDDetails |
403 | Forbidden | Forbidden | DefLegProcIDDetails |
404 | Not Found | Recurso no encontrado | DefLegProcIDDetails |
500 | Internal Server Error | Internal error | DefLegProcIDDetails |
Schemas
DefLegProcDetails
"{"claims":[{}],"claimsNumber":0}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
claims | [object] | false | none | none |
claimsNumber | number | false | none | none |
DefLegProcIDDetails
"{"claimed":"string","courtNumber":0,"courtTown":"string","courtType":"string","defendants":[{"address":{"country":{"code":"string","value":"string"},"dateUntil":"2019-10-04T08:16:40.791Z","fullAddress":"string","number":"string","otherDetails":"string","postcode":"string","province":{"code":"string","value":"string"},"streetName":"string","streetType":{"code":"string","value":"string"},"town":{"code":"string","value":"string"},"urbanArea":"string"},"companyName":"string","taxId":"string"}],"embargoed":"string","embargoedAddress":[{"address":{"country":{"code":"string","value":"string"},"dateUntil":"2019-10-04T08:16:40.791Z","fullAddress":"string","number":"string","otherDetails":"string","postcode":"string","province":{"code":"string","value":"string"},"streetName":"string","streetType":{"code":"string","value":"string"},"town":{"code":"string","value":"string"},"urbanArea":"string"},"homeValuation":"string"}],"orderNumber":"string","plaintiffs":[{"address":{"country":{"code":"string","value":"string"},"dateUntil":"2019-10-04T08:16:40.791Z","fullAddress":"string","number":"string","otherDetails":"string","postcode":"string","province":{"code":"string","value":"string"},"streetName":"string","streetType":{"code":"string","value":"string"},"town":{"code":"string","value":"string"},"urbanArea":"string"},"companyName":"string","taxId":"string"}],"proceeding":"string","proceedingDate":"string","publications":[{"datePublished":"string","media":{"code":"string","value":"string"}}],"rating":"string","status":"string","statusDate":"string","statusHistory":[{"estado":"string","fecha":"string"}]}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
claimed | string | false | none | none |
courtNumber | number | false | none | none |
courtTown | string | false | none | none |
courtType | string | false | none | none |
defendants | [object] | false | none | none |
address | object | false | none | none |
country | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
dateUntil | string | false | none | none |
fullAddress | string | false | none | none |
number | string | false | none | none |
otherDetails | string | false | none | none |
postcode | string | false | none | none |
province | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
streetName | string | false | none | none |
streetType | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
town | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
urbanArea | string | false | none | none |
companyName | string | false | none | none |
taxId | string | false | none | none |
embargoed | string | false | none | none |
embargoedAddress | [object] | false | none | none |
address | object | false | none | none |
country | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
dateUntil | string | false | none | none |
fullAddress | string | false | none | none |
number | string | false | none | none |
otherDetails | string | false | none | none |
postcode | string | false | none | none |
province | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
streetName | string | false | none | none |
streetType | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
town | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
urbanArea | string | false | none | none |
homeValuation | string | false | none | none |
orderNumber | string | false | none | none |
plaintiffs | [object] | false | none | none |
address | object | false | none | none |
country | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
dateUntil | string | false | none | none |
fullAddress | string | false | none | none |
number | string | false | none | none |
otherDetails | string | false | none | none |
postcode | string | false | none | none |
province | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
streetName | string | false | none | none |
streetType | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
town | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
urbanArea | string | false | none | none |
companyName | string | false | none | none |
taxId | string | false | none | none |
proceeding | string | false | none | none |
proceedingDate | string | false | none | none |
publications | [object] | false | none | none |
datePublished | string | false | none | none |
media | object | false | none | none |
code | string | false | none | none |
value | string | false | none | none |
rating | string | false | none | none |
status | string | false | none | none |
statusDate | string | false | none | none |
statusHistory | [object] | false | none | none |
estado | string | false | none | none |
fecha | string | false | none | none |
ErrorDetail
"{"code":"string","message":"string","principal":"string","status":0}"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | string | false | none | none |
message | string | false | none | none |
principal | string | false | none | none |
status | number | false | none | none |