Documentación de Activity

NAV Navigation

ActivityApi 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 (APIKeyHeader)

    • Parameter Name: X-IBM-Client-Id, in: header.
  • API Key (ClientSecretHeader)

    • Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract

Default

get__activity_{organisationID}

Code samples

URL obj = new URL("https://$(catalog.host)/modules/activity/{organisationID}");

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/activity/{organisationID}',

{

 method: 'GET',


 headers: headers

})

.then(function(res) {

 return res.json();

}).then(function(body) {

 console.log(body);

});


GET https://$(catalog.host)/modules/activity/{organisationID} 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/activity/{organisationID}', 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/activity/{organisationID}', 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/activity/{organisationID}',

 params: {

 }, headers: headers


p JSON.parse(result)


# You can also use wget

curl -X GET https://$(catalog.host)/modules/activity/{organisationID} \

 -H 'Accept: application/json' \

 -H 'X-IBM-Client-Id: API_KEY' \

 -H 'X-IBM-Client-Secret: API_KEY'



GET /activity/{organisationID}

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

"{"activities":[{"code":"string","description":"string","type":"string"}],"activityDescription":"string","companyExperience":{"experienceCompanyName":{"companyName":"string","countryCode":"string"},"experienceRating":"string","experienceReason":"string"},"exclusiveDistributor":"string","expectedStartDate":"string","franchises":{"items":[{"commercialTitle":"string","establishmentNumber":"string","franchiseName":{"companyName":"string","countryCode":"string"}}],"unavailabilityReason":"string"},"incorporated":"string","managerExperience":{"managerExperienceType":"string","previousExperienceRating":"string"},"notAvailable":"string","startYear":"string"}"


Responses

Status Meaning Description Schema
200 OK 200 OK activityDetail
401 Unauthorized Unauthorized ErrorDetail
403 Forbidden Forbidden 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 number false none none

activityDetail

"{"activities":[{"code":"string","description":"string","type":"string"}],"activityDescription":"string","companyExperience":{"experienceCompanyName":{"companyName":"string","countryCode":"string"},"experienceRating":"string","experienceReason":"string"},"exclusiveDistributor":"string","expectedStartDate":"string","franchises":{"items":[{"commercialTitle":"string","establishmentNumber":"string","franchiseName":{"companyName":"string","countryCode":"string"}}],"unavailabilityReason":"string"},"incorporated":"string","managerExperience":{"managerExperienceType":"string","previousExperienceRating":"string"},"notAvailable":"string","startYear":"string"}"



Properties

Name Type Required Restrictions Description
activities [object] false none none
  code string false none none
  description string false none none
  type string false none none
activityDescription string false none none
companyExperience object false none none
  experienceCompanyName object false none none
   companyName string false none none
   countryCode string false none none
  experienceRating string false none none
  experienceReason string false none none
exclusiveDistributor string false none none
expectedStartDate string false none none
franchises object false none none
  items [object] false none none
   commercialTitle string false none none
   establishmentNumber string false none none
   franchiseName object false none none
    companyName string false none none
    countryCode string false none none
  unavailabilityReason string false none none
incorporated string false none none
managerExperience object false none none
  managerExperienceType string false none none
  previousExperienceRating string false none none
notAvailable string false none none
startYear string false none none

imagen de contacto

Solicita más información

Esta web utiliza cookies

Utilizamos cookies de terceros con finalidades analíticas (elaborar estadísticas a partir de sus hábitos de navegación), de personalización (para recordar idioma o la configuración web preferida), y de publicidad comportamental (para elaborar perfiles y ofrecerles publicidad adaptada a sus preferencias de navegación). Puede configurar ahora el uso de esta tecnología. Asimismo, puede modificar o retirar su consentimiento en cualquier momento haciendo clic en nuestra Política de Cookies.

Publicidad Comportamental

Las cookies de marketing se utilizan para rastrear a los visitantes en las páginas web. La intención es mostrar anuncios relevantes y atractivos para el usuario individual, y por lo tanto, más valiosos para los editores y terceros anunciantes.

Necesarias

Las cookies necesarias ayudan a hacer una página web utilizable activando funciones básicas como la navegación en la página y el acceso a áreas seguras de la página web. La página web no puede funcionar adecuadamente sin estas cookies.

Estadísticas

Las cookies estadísticas ayudan a los propietarios de páginas web a comprender cómo interactúan los visitantes con las páginas web reuniendo y proporcionando información de forma anónima.

Preferencias

Las cookies de preferencias permiten a la página web recordar información que cambia la forma en que la página se comporta o el aspecto que tiene, como su idioma preferido o la región en la que usted se encuentra.