Documentación de Organisations

OrganisationsApi 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:

https://$(catalog.host)/modules

Email: Iberinform Web: Iberinform

Authentication

API Key (ClientSecretHeader)
- Parameter Name: X-IBM-Client-Secret, in: header. Secret Key
API Key (APIKeyHeader)
- Parameter Name: X-IBM-Client-Id, in: header. Unique token directly related to the client contract

Organisations

Organisations requests

get__organisations_

Code samples

URL obj = new URL("https://$(catalog.host)/modules/organisations/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
 new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
 response.append(inputLine);
}
in.close();
System.out.println(response.toString());


const headers = {
 'Accept':'application/json',
 'X-IBM-Client-Id':'API_KEY',
 'X-IBM-Client-Secret':'API_KEY'
};

fetch('https://$(catalog.host)/modules/organisations/',
{
 method: 'GET',

 headers: headers
})
.then(function(res) {
 return res.json();
}).then(function(body) {
 console.log(body);
});

GET https://$(catalog.host)/modules/organisations/ HTTP/1.1

Accept: application/json

 'application/json',
 'X-IBM-Client-Id' => 'API_KEY',
 'X-IBM-Client-Secret' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
 $response = $client->request('GET','https://$(catalog.host)/modules/organisations/', array(
 'headers' => $headers,
 'json' => $request_body,
 )
 );
 print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
 // handle exception or api errors.
 print_r($e->getMessage());
 }

 // ...

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/organisations/', headers = headers)

print(r.json())

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/organisations/',
 params: {
 }, headers: headers

p JSON.parse(result)

# You can also use wget
curl -X GET https://$(catalog.host)/modules/organisations/ \
 -H 'Accept: application/json' \
 -H 'X-IBM-Client-Id: API_KEY' \
 -H 'X-IBM-Client-Secret: API_KEY'

GET /organisations/

Parameters

Name	In	Type	Required	Description
user	query	string	false	Alias del usuario
lang	query	string	false	Idioma del usuario
maxOrgs	query	integer(int32)	false	Número máximo de firmas de las localizadas a devolver
name	query	string	false	Denominación por la que se quiere localizar firmas
country	query	string	false	País
street	query	string	false	Calle
city	query	string	false	Municipio
postCode	query	string	false	Código postal
countrySubidentName	query	string	false	Provincia
registeredOfficeCode	query	string	false	Número de identificación (NIF,CIF)
minScore	query	number(double)	false	Puntuación mínima de coincidencia de las firmas localizadas con la Denominación y Datos del Domicilio.

Example responses

200 Response

{
 "baseRequest": {
 "lang": "string",
 "user": "string"
 },
 "count": 0,
 "organisations": [
 {
 "activity": {
 "activityClassCode": "string",
 "activityClassDesc": "string",
 "activityClassType": "string",
 "activityClassVersion": "string"
 },
 "legalForm": "string",
 "nameAddress": {
 "address": {
 "city": "string",
 "country": "string",
 "countrySubident": "string",
 "postCode": "string",
 "street": "string"
 },
 "name": "string"
 },
 "orgIdent": {
 "orgIdentId": 0,
 "orgIdentStrId": "string",
 "orgIdentType": "string"
 },
 "orgStatus": {
 "statusCode": "string",
 "statusDate": "string",
 "statusDesc": "string"
 },
 "registeredOffice": {
 "registeredOfficeCode": "string",
 "registeredOfficeType": "string"
 },
 "scoreCS": 0
 }
 ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Recurso recuperado correctamente	searchResult_organisation_
400	Bad Request	Parametros de peticion incorrectos	ErrorDetail
401	Unauthorized	No autorizado	ErrorDetail
403	Forbidden	Acceso no permitido	ErrorDetail
404	Not Found	Recurso no encontrado	ErrorDetail
500	Internal Server Error	Internal error	ErrorDetail

Schemas

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	integer(int32)	false	none	none

baseRequest

{
 "lang": "string",
 "user": "string"
}

Properties

Name	Type	Required	Restrictions	Description
lang	string	false	none	Código del idioma en el que se están retornando las descripciones
user	string	false	none	Alias del usuario

organisation

{
 "activity": {
 "activityClassCode": "string",
 "activityClassDesc": "string",
 "activityClassType": "string",
 "activityClassVersion": "string"
 },
 "legalForm": "string",
 "nameAddress": {
 "address": {
 "city": "string",
 "country": "string",
 "countrySubident": "string",
 "postCode": "string",
 "street": "string"
 },
 "name": "string"
 },
 "orgIdent": {
 "orgIdentId": 0,
 "orgIdentStrId": "string",
 "orgIdentType": "string"
 },
 "orgStatus": {
 "statusCode": "string",
 "statusDate": "string",
 "statusDesc": "string"
 },
 "registeredOffice": {
 "registeredOfficeCode": "string",
 "registeredOfficeType": "string"
 },
 "scoreCS": 0
}

Properties

Name	Type	Required	Restrictions	Description
activity	activity	true	none	Información sobre la actividad de la empresa
legalForm	string	true	none	Forma jurídica de la empresa
nameAddress	nameAddress	true	none	Nombre y dirección de la empresa
orgIdent	orgIdent	true	none	none
orgStatus	orgStatus	true	none	Información del estado de la empresa
registeredOffice	registeredOffice	true	none	none
scoreCS	number(double)	true	none	Puntuación CS

activity

{
 "activityClassCode": "string",
 "activityClassDesc": "string",
 "activityClassType": "string",
 "activityClassVersion": "string"
}

Properties

Name	Type	Required	Restrictions	Description
activityClassCode	string	true	none	Código
activityClassDesc	string	true	none	Descripción
activityClassType	string	true	none	Tipo de actividad
activityClassVersion	string	true	none	Versión

nameAddress

{
 "address": {
 "city": "string",
 "country": "string",
 "countrySubident": "string",
 "postCode": "string",
 "street": "string"
 },
 "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
address	address	true	none	Dirección
name	string	true	none	Nombre de la empresa

orgIdent

{
 "orgIdentId": 0,
 "orgIdentStrId": "string",
 "orgIdentType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
orgIdentId	integer(int32)	true	none	none
orgIdentStrId	string	true	none	none
orgIdentType	string	true	none	none

orgStatus

{
 "statusCode": "string",
 "statusDate": "string",
 "statusDesc": "string"
}

Properties

Name	Type	Required	Restrictions	Description
statusCode	string	true	none	Código
statusDate	string	true	none	Fecha
statusDesc	string	true	none	Descripción

registeredOffice

{
 "registeredOfficeCode": "string",
 "registeredOfficeType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
registeredOfficeCode	string	true	none	Código de oficina
registeredOfficeType	string	true	none	Tipo de oficina

address

{
 "city": "string",
 "country": "string",
 "countrySubident": "string",
 "postCode": "string",
 "street": "string"
}

Properties

Name	Type	Required	Restrictions	Description
city	string	true	none	Municipio
country	string	true	none	País
countrySubident	string	true	none	Provincia
postCode	string	true	none	Código postal
street	string	true	none	Calle

organisationsArray

[
 {
 "activity": {
 "activityClassCode": "string",
 "activityClassDesc": "string",
 "activityClassType": "string",
 "activityClassVersion": "string"
 },
 "legalForm": "string",
 "nameAddress": {
 "address": {
 "city": "string",
 "country": "string",
 "countrySubident": "string",
 "postCode": "string",
 "street": "string"
 },
 "name": "string"
 },
 "orgIdent": {
 "orgIdentId": 0,
 "orgIdentStrId": "string",
 "orgIdentType": "string"
 },
 "orgStatus": {
 "statusCode": "string",
 "statusDate": "string",
 "statusDesc": "string"
 },
 "registeredOffice": {
 "registeredOfficeCode": "string",
 "registeredOfficeType": "string"
 },
 "scoreCS": 0
 }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[organisation]	false	none	none

searchResult_organisation_

{
 "baseRequest": {
 "lang": "string",
 "user": "string"
 },
 "count": 0,
 "organisations": [
 {
 "activity": {
 "activityClassCode": "string",
 "activityClassDesc": "string",
 "activityClassType": "string",
 "activityClassVersion": "string"
 },
 "legalForm": "string",
 "nameAddress": {
 "address": {
 "city": "string",
 "country": "string",
 "countrySubident": "string",
 "postCode": "string",
 "street": "string"
 },
 "name": "string"
 },
 "orgIdent": {
 "orgIdentId": 0,
 "orgIdentStrId": "string",
 "orgIdentType": "string"
 },
 "orgStatus": {
 "statusCode": "string",
 "statusDate": "string",
 "statusDesc": "string"
 },
 "registeredOffice": {
 "registeredOfficeCode": "string",
 "registeredOfficeType": "string"
 },
 "scoreCS": 0
 }
 ]
}

Properties

Name	Type	Required	Restrictions	Description
baseRequest	baseRequest	true	none	BaseRequest
count	integer(int32)	true	none	Número de empresas localizadas
organisations	organisationsArray	true	none	Listado que contiene las empresas que cumplen los criterios de la petición

Java JavaScript HTTP PHP Python Ruby Shell

Documentación de Organisations

OrganisationsApi v1.0.0

Authentication

Organisations

get__organisations_

Parameters

Responses

Schemas

ErrorDetail

Properties

baseRequest

Properties

organisation

Properties

activity

Properties

nameAddress

Properties

orgIdent

Properties

orgStatus

Properties

registeredOffice

Properties

address

Properties

organisationsArray

Properties

searchResult_organisation_

Properties

Solicita más información

Gestiona el uso de las cookies

Configura tus preferencias

Su privacidad

Cookies estrictamente necesarias

Cookies funcionales de preferencias o personalización

Cookies de análisis o medición

Cookies de publicidad comportamental

No clasificados

Su privacidad

Cookies estrictamente necesarias

Cookies funcionales de preferencias o personalización

Cookies de análisis o medición

Cookies de publicidad comportamental

No clasificados