Example use case of endpoint: an OTA (online travel agency, a marketplace within the tourism sector) wants to know which hotels on their platform have an eco-certification. Thus, they send a list of their hotels (along with the internal IDs for each hotel and its public identifying information) to this endpoint. The next time the OTA fetches the list of certified accommodations (through the companies/search endpoint) the list of returned accommodations will also have the IDs provided by the OTA as attributes (granted a match was found between the OTAs provided data, and the data in BeCause). This makes it trivial for the OTAs to map the returned certified hotels to their own dataset via the IDs.
\nTo subsequently get the status and result of your company-mapping request please refer to the /status/{correlationId} endpoint. Here you'll also find a description of the specific response model returned.
\nPayload Description:
\n","urlObject":{"path":["v1","bulk","company-mappings"],"host":["https://api.because.eco/api"],"query":[],"variable":[]}},"response":[{"id":"d7f8afc8-d157-4351-97c7-71c3c78e319f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Used by integrating marketplaces to associate their internal reference IDs with one or more companies within the BeCause infrastructure. The marketplace provides a list of companies with their own internal IDs, along with as much public identifying information for the company as is available. BeCause’s infrastructure will afterward search for these companies and associate the IDs of the marketplaces with the found companies.
\nWhile there are no hard limits on the size of the payloads, we recommend not providing more than 100k companies for mapping in each submitted payload to avoid being affected by limits in the future.
\nTo subsequently get the status and result of your company-mapping request please refer to the /status/{correlationId} endpoint. Here you'll also see a description of the response model returned.
\n","_postman_id":"f70283de-d52e-48dd-86ee-289f948339ed"},{"name":"Search endpoints","item":[{"name":"/bulk/companies/search","id":"f0ed8b11-6381-4b52-b6d6-3569ea58c7b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Used for creating a new search request for one or more companies within the BeCause infrastructure. The search request for the companies is based on their awarded certifications.
\nTo subsequently get the status and result of your companies search request please refer to the /status/{correlationId} endpoint. Here you'll also find a description of the specific response model returned.
\nPayload Description:
\n","urlObject":{"path":["v1","bulk","companies","search"],"host":["https://api.because.eco/api"],"query":[],"variable":[]}},"response":[{"id":"1e12fe8b-f973-49fb-a6fe-0d4f3b81d730","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Used for creating a new search request for one or more standards (certifications) on the BeCause platform.
\nTo subsequently get the status and result of your standards search request please refer to the /status/{correlationId} endpoint. Here you'll also find a description of the specific response model returned.
\nPayload Description:
\n","urlObject":{"path":["v1","bulk","standards","search"],"host":["https://api.because.eco/api"],"query":[],"variable":[]}},"response":[{"id":"684acff7-c14c-483e-9e2b-0efa0abdeb19","name":"Succcess","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Used for creating a new search request for the data of one or more calculators (current HCMI and HWMI) on the BeCause platform.
\nTo subsequently get the status and result of your calculators search request please refer to the /status/{correlationId} endpoint. Here you'll also find a description of the specific response model returned.
\nPayload Description:
\n","urlObject":{"path":["v1","bulk","calculators","search"],"host":["https://api.because.eco/api"],"query":[],"variable":[]}},"response":[{"id":"22f84185-5c83-4fae-86dd-263eb2f2c363","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Used for creating a new search request for all answers provided within a selected framework.
\nTo subsequently get the status and result of your framework answers search request please refer to the /status/{correlationId} endpoint. Here you'll also find a description of the specific response model returned.
\nPayload Description:
\n","urlObject":{"path":["v1","bulk","framework-answers","search"],"host":["https://api.because.eco/api"],"query":[],"variable":[]}},"response":[{"id":"a9d9de5c-70c8-4727-aee6-00bc163d98ea","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Gets the structure of a data collection framework. The structure consists of topics (e.g. Energy & Climate Change), subtopics (e.g. GHG Emissions), questions (e.g. scope 1) and datapoints (e.g. how much has been emitted, and what is the unit of measure).
\nParameters:
\n- \n
frameworkId:The ID of the framework for which the structure should be returned. You need to have access to the framework to export the structure. \n
(Required)
\n","type":"text/plain"},"type":"any","value":"We offer multiple endpoints for creating search requests within the BeCause infrastructure. These can be used to fetch certified companies (along with your internal ID), logos, and levels from certifications, framework answers, and other useful sustainability data found on BeCause.
\nTo subsequently get the status and result of your search request please refer to the /status/{correlationId} endpoint.
\n","_postman_id":"07b11db2-a289-44bc-b305-dec512e34741"},{"name":"Get status of your request","item":[{"name":"/bulk/status/:correlationId","id":"d67f7fb0-465a-4444-b2ae-363e93f63fc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Parameters:
\n- \n
correlationId:The ID returned in the response from any of the previously described POST endpoints. \n
Response Description:
\nResponse model: Company Mapping request
\nPlease refer to the /company-mapping endpoint for a description of the request.
\nA CSV file. Each row (except the header row) in the CSV file contains:
\nOne of the companies submitted for ID mapping by the marketplace.
The company it was mapped to within BeCause’s infrastructure, if any.
The confidence in the correctness of the mapping (represented by an enum).
Note: The result of the mapping is also visible by calling the search/companies endpoint. The response payload from this method will contain the provided marketplace IDs for each returned company, whenever a match has been made.
\nResponse model: Company search
\nArray of companies on BeCause matching the search request. Please refer to the /companies/search endpoint for a description of the request. Each found company has the following properties:
\nResponse model: Standard search
\nAn array of certifications. Please refer to the /standards/search endpoint for a description of the request.
\nThe certifications found within BeCause’s infrastructure based on the search query. If a certification you searched for does not appear in this table, it was not found. Each found certification has the following properties
\nResponse model: Calculators
\nAn Array of Companies. Please refer to the /calculators/search endpoint for a description of the request. The companies found within the requested groups that you requested calculator data for. For each company, the following data is provided:
\nResponse model: Framework Answers
\nThe companies found within the requested groups that you framework answers for. Please refer to the /framework-answers/search endpoint for a description of the request.
\nFor each company, the following data is provided:
\n","urlObject":{"path":["v1","bulk","status",":correlationId"],"host":["https://api.because.eco/api"],"query":[],"variable":[{"type":"any","value":"","key":"correlationId"}]}},"response":[{"id":"8bbfe9c5-4e02-4593-a579-d73b111f10a4","name":"example: Status","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Returns the status of your request. If the request has completed, the returned response also contains the link to retrieve the JSON-formatted result and/or error of the search request.
\nFurther down you will find the specific response models for each request-type. You can see JSON examples of each response model by switching between requests in the Example Request section:
\nThe following sections describe how to use the BeCause.eco API for Marketplaces. It focuses on two primary primary areas:
\n- \n
Company mappings
\n \nSearch endpoints
\n \n
Company mappings are used to associate your internal reference IDs with one or more companies within the BeCause infrastructure. The search endpoints are used to search for companies, standards, framework answers, etc. within the BeCause infrastructure.
\n","_postman_id":"bff525a1-4872-45e4-87fd-f1a8d319eed6"},{"name":"Certifier API Docs","item":[{"name":"Import establishment data","item":[{"name":"/bulk/consolidated/upsert-standard-holders","id":"296bd50a-f1a3-4ff1-8f73-c98bfbffaa2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"As the consumer of this API, you are considered the standard body, i.e., the entity that owns and/or may issue the standard to profiles on BeCause (aka standard holders).
\nOn a BeCause profile holding your standard, some fields are directly related to your standard. These fields can generally be overwritten freely (only by you) in subsequent requests. These fields include custom properties on the profile, custom properties on the standard, start/end date on the standard, etc.
\nIt is recommended that you always include a custom identifier (which could match the ID you use in your internal system). You can find all accessible custom identifiers using the /custom-properties/custom-identifiers endpoint. This ensures that you always target the same profile in the future, instead of relying on our system to search for the profile by other identifiers (which may lead to duplicate profiles). Even if you provide a custom identifier, it's still valuable to provide as much information about the profile as possible so the profile is easier to identify in the future even when not using your specific custom ID. Any combination of identifying properties must be unique across the whole input dataset.
\nTo subsequently get the status of your request, please refer to the /status/{correlationId} endpoint.
\nPayload Description
\n- \n
\ngroupId:guidId of your company's group on the BeCause platform. All accessible group ids can be found using the /groups endpoint. \n
\ncompanies:Company[ ]- \n
\nname:stringRequired. Name of the company. \n
\nidentifier:IdentifierAt least one identifying property must be given (clientReferenceIdis not an identifying property; it is just a reference). Any combination of identifying properties must be unique across the whole input dataset.- \n
\nbecauseProfileId:guidOptional. If provided, no other identifying properties will be considered in the search. If a company with this Id cannot be found, the input row will be rejected. \n
\ndomainName:stringOptional. Accepted format examples: “because.eco”, “https://because.eco”, “https://www.because.eco”, “because.eco/page”, etc.
Note: Only the domain name is extracted, so all the listed examples have identical domain names. \n
\nvatNumber:stringOptional. Examples: “12345678”, “DK12345678” \n
\nclientReferenceId:stringOptional. This value is not saved on the BeCause profile. Its only function is to associate an output row more easily with an input identifier. \n
\nlocationCoordinates:LocationCordinatesRequired.- \n
\nlatitude:decimalRequired. Example: 55.6622668 \n
\nlongitude:decimalRequired. Example: 12.5849778 \n
\n
\ncustomIdentifiers:CustomIdentifier[ ]Optional. If provided, it will be prioritized when matching. If a match is made bycustomIdentifier, secondary identifiers (domain name, VAT, location coordinates) will not be considered. If not provided, or an empty array is provided, existing customIdentifiers on the profile will remain untouched.- \n
\nid:guidRequired. This is the id of a custom profile property on your profile. The custom property must be marked as an identifier. You can access your existing custom identifiers by using the /custom-properties/custom-identifiers endpoint. \n
\nvalue:stringRequired. Must be unique across the whole dataset, meaning you cannot have 2 different profiles with the same custom identifier value. \n
\n
\n
\ncompanyAddress:CompanyAddress- \n
\nstreetAddress:stringRequired \n
\nzipCode:stringRequired \n
\ncity:stringRequired \n
\nregion:stringOptional \n
\nthreeLetterCountryCode:stringRequired. According to ISO3166-1 alpha-3 \n
\nsubdivisionCountryCode:stringISO 3166-2 subdivision country code. If it has a value, it can be considered a precision of the country specified by the ISO 3166-1 code. This is mainly relevant for distinguishing between countries in the UK. For example, subdivision code \"GB-WLS\" refers to \"Wales\" (which in ISO3166-1 is just part of \"GBR\"). \n
\n
\ncustomProperties:ProfileProperty[ ]Optional. If not provided, or an empty array is provided, existing custom properties for this profile will remain untouched.- \n
\npropertyId:guidRequired \n
\nvalue:stringRequired. If the property is a List-type, the value should either be the id (guid) or the label of an allowed list value. \n
\n
\ncertifications:Certification[ ]Optional. If not provided, or an empty array is provided, existing certifications for this profile will remain untouched.- \n
\ncertificationId:guidRequired. Id of the Certification on the BeCause platform. \n
\nstartDateUtc:dateOptional. If not given, the Certification for this company is not restricted by a start date. Specifies the date from which the Certification is active for this company. Before this date, the Certification for this company will not be displayed on the platform or in widgets. Accepted format examples: “2021-12-09”, “2021-12-09T17:37:39.282109”. Must be beforeendDateUtc. \n
\nendDateUtc:dateRequired. If you do not provide an end date, the certification is not considered to be active. Specifies the date from which the Certification is no longer active for this company – can be seen as expiration date. After this date, the Certification for this company will be excluded or marked as expired in all channels that communicate it (widgets, APIs, exports, etc.) Accepted format examples: “2023-12-09”, “2021-12-09T17:37:39.282109”. Must be afterstartDateUtc, ifstartDateUtcis given. \n
\nlinks:string[ ]Optional. If not provided, or an empty array is provided, existing links will remain untouched. Each string in the array is expected to be a URL. Example: “https://because.eco/page/39745267” \n
\nproperties:StandardProperty[ ]Optional. If not provided, or an empty array is provided, existing properties for this profile’s Certification will remain untouched.- \n
\nid:guidRequired. The id of the property defined on the Standard (i.e., Commitment or Certification). \n
\nvalue:string, but value format depends on the type of property:- \n
\nDecimal:124.1 (or as a string \"124.1\") \n
\nBoolean:true, false (or as a string \"true\", \"false\") \n
\nString:LocaleString\n
\nList:The guid of the value from the list of allowed values you want to assign. Your technical contact at BeCause can provide a list of possible values.
Note: Certification Level (aka Standard Level) is provided here. \n
\n
\n
\nvalidation:ValidationOptional. If not provided,validationStatewill default to \"Valid\". Note that all states except \"Valid\" are treated the same on the platform.- \n
\nvalidationState:string: Available values:- \n
Valid: The company is certified.
\n \nUnvalidated: The certification data provided for the company has not yet been validated by the certifier.
\n \nInvalid: The company's certification is invalid.
\n \nRevoked: The company's certification was revoked by the certifier.
\n \n
\n
\n
\nfirsIssuedYear:intOptional. Indicates the year that this company was first issued the certification. \n
\n
\ncommitments:Commitment[ ]Optional. If not provided, or an empty array is provided, existing commitments for this profile will remain untouched.- \n
\ncommitmentId:guidRequired. Id of the Commitment on the BeCause platform. \n
\nstartDateUtc:dateSame as the Certification model. \n
\nendDateUtc:dateSame as the Certification model. \n
\nlinks:string[ ]Same as the Certification model. \n
\nproperties:Property[ ]Same as the Certification model. \n
\nvalidation:ValidationSame as the Certification model. \n
\n
\nclaimInvitationEmail:stringOptional. An invitation e-mail will be sent to this address for this person to claim the company if it is not already claimed. \n
\ncontacts:CompanyContact [ ]- \n
\nname:stringRequired \n
\nemail:stringOptional \n
\nphone:stringOptional \n
\ncontactType:ContactTypeOptional. If not provided, will default to typeNone.
There may only be 1Primaryand 1Generalcontact. If you provide a Primary contact when one already exists, the existing will be overwritten.- \n
Avaliable types:
\n- \n
\nNone\n
\nPrimaryPerson\n
\nGeneral\n
\n
\n
\n
\n
This endpoint allows you to create or update company profiles on BeCause.eco, associating them with your Standards (eg. certifications or commitments).
\nUsually, you will send information on all active members of your organization (e.g., companies holding your certification). You should supply as much identifying information as possible for each input company (such as domain name, VAT number, or location coordinates) and a Standard to assign to that profile.
\nAs a result, your members will be represented on BeCause.eco with public profile pages displaying their Standard. In addition, the members will be added to your Group on BeCause, which gives you an overview of your members. You may allow other parties, such as OTAs, to export data related to your members.
\n","_postman_id":"791fc557-7caf-48ad-b345-02cf88f6bffe"},{"name":"Import performance answers","item":[{"name":"/bulk/performance-answers/upsert","id":"84cbff61-7080-4777-b330-492869fd27a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Used for bulk import of performance answers to data points in specific performance frameworks for one or more companies within the BeCause infrastructure. The import request will be processed by the first available node. Queued requests from the same API key are processed after the FIFO principle.
\nPayload description
\n- \n
\nframeworkId:guidFramework id for which the answers are being imported. All accessible frameworks can be found using the /frameworks endpoint. \n
\ncustomIdentifierId:guidCustom identifier id. All accessible custom identifiers can be found using the /custom-properties/custom-identifiers endpoint. \n
\ncompanyAnswers:- \n
\ncustomIdentifierValue:stringCustom property value of the company for which answers are being submitted. All accessible company identifiers can be found using the /groups/{groupId}/members?customIdentifierId={customIdentifierId} endpoint. \n
\nreportingPeriod:enumReporting period for which answers are being submitted. List of possible values:
▪ JanDec ▪ FebJan ▪ MarFeb ▪ AprMar ▪ MayApr ▪ JunMay ▪ JulJun ▪ AugJul ▪ SepAug ▪ OctSep ▪ NovOct ▪ DecNov\n
\nreportingYear:intThe year that reporting starts in. For example, ifreportingYearis2024, andreportingPeriodisAprMar, then the reporting period is April 2024 to March 2025 (both months included, so 12 months total). \n
\nanswers:- \n
\ndataPointId:guidId of data point for which the response is provided. All datapoint ids for selected framework can be found using the /frameworks/{frameworkId} endpoint. \n
\nperiodValue:stringThis parameter is required for all data points with reporting type of Yearly, representing the annual value for the specified data point. Reporting period type for the data point can be found using the /frameworks/{frameworkId} endpoint. \n
\nunitOfMeasure:stringRepresents the unit of measure in which the response to a specific data point is given. The unit types available for a datapoint depend on which unit type is configured (e.g. mass, volume, energy, etc.). The list of available units for a datapoint can be found using the /unit-types endpoint. \n
\njanStartYearValue, febStartYearValue, marStartYearValue, aprStartYearValue, mayStartYearValue, junStartYearValue, julStartYearValue, augStartYearValue, sepStartYearValue, octStartYearValue, novStartYearValue, decStartYearValue, janEndYearValue, febEndYearValue, marEndYearValue, aprEndYearValue, mayEndYearValue, junEndYearValue, julEndYearValue, augEndYearValue, sepEndYearValue, octEndYearValue, novEndYearValue:A subset of these parameters should be provided if the reporting type for the datapoint is Monthly or Any. If the reporting type is Monthly, at least one monthly value is required. You only need to include values for the months included in the givenreportingPeriod(e.g. forMarFeb, you provide values formarStartYearValuetofebEndYearValue). If you don’t provide values for the months within the selected reporting period for the monthly answers, you will receive an error. Reporting period type for data point can be found using the /frameworks/{frameworkId} endpoint. \n
\n
\n
This endpoint enables bulk uploading of answers to Performance questions (metrics) for companies on BeCause. Note that the target companies must already exist on the platform and be identifiable by a custom identifier. For information on creating new companies, please refer to the 'Import Establishment Data' section above.
\nTo subsequently get the status of your request please refer to the /status/{correlationId} endpoint.
\n⚠️ Important: Verified data responsibility (for certifiers*)
\nWhen a certification body uses the API to upload data on behalf of an establishment, all submitted values will be treated as verified data.
Only upload data that has already been verified through an audit or equivalent process.
Do not submit unverified data.
*This rule does not apply to hotel chains submitting their own data via API. Data from hotel chains is not treated as verified until it goes through an official verification process.
Glossary
\n- \n
Framework: Collection of Questions, which in turn contains one or more DataPoints.
\n \nDataPoint: Individual data points specifying one input field, e.g. a single text field, number field, dropdown, etc.
\n \nAnswer: A profile’s answer to a DataPoint. Answers always exist in the context of a ReportingPeriod and ReportingYear.
\n \nReportingPeriod: A range specifying the period for which the given answer counts. Within a reporting period, an answer can be tied to either one month, the whole period, or both. A reporting period is always 12 months and is defined by a start and end month, e.g. Jan-Dec.
\n \nPerformance: BeCause’s general term for metric and questionnaire data
\n \nCustom Identifier: A custom property owned by your company profile on BeCause, used to uniquely identify other companies on BeCause. This can e.g. be the id from your own system. These custom identifiers are assigned to companies in other flows, e.g. the Establishment Data Import.
\n \n
Used to gather frameworks accessible to company.
\nResponse description
\n- \n
\nid:guidFramework Id \n
\ntitle:stringFramework title \n
Used to gather groups accessible to company.
\nResponse description
\n- \n
\nid:guidGroup id \n
\nname:stringGroup name \n
Used to gather custom identifiers accessible to company.
\nResponse description
\n- \n
\nid:guidCustom identifier id \n
\nname:stringCustom identifier name \n
Used to gather all available companies from the group along with the necessary information for bulk performance answers import. If a group member does not have a value for the specified customIdentifierId, it will not be included in the result.
\nParameters
\n- \n
\ngroupId:Group id for which we are gathering members (companies with their identifiers) \n
\ncustomIdentifierId:Id of the custom identifier to include for all members in the group \n
Response description
\n- \n
\nname:stringName of company \n
\nid:guidId of company \n
\ncustomIdentifierId:guidId of custom identifier \n
\ncustomIdentifierValue:stringCompany identifier value for specified custom identifier \n
Used to gather data points for performance answers import based on provided framework id.
\nParameters
\n- \n
frameworkId:Framework id for which data points are needed, can be found via the /frameworks endpoint \n
Response description
\nThe response contains the whole hierarchy of the framework. It is primarily the questions and datapoints that are relevant for the answer import. The rest of the framework hierarchy (topics, etc.) is included for context.
\n- \n
\nframework:- \n
\nid:guid\n
\ntitle:string\n
\ntotalQuestions:numberTotal number of questions in the framework. \n
\ntotalReqiredQuestions:numberTotal number of required questions in the framework \n
\nscoreCategories:[ ]An array of score categories in the framework.- \n
\nid:guid\n
\nname:string\n
\nattainableScore:intMaximum score attainable by answering the questions in framework within scoring category \n
\n
\ntopics[ ]An array of topics covered in the framework- \n
\nid:guid\n
\ntitle:string\n
\nsubtopics[ ]An array of subtopics within each topic- \n
\nid:guid\n
\ntitle:string\n
\ndisplayOrderIndex:intAn integer indicating the display order of the subtopic \n
\nquestionClusters[ ]An array of question clusters within each subtopic- \n
\nid:guid\n
\ntitle:string\n
\ndisplayOrderIndex:intAn integer indicating the display order of question cluster \n
\nquestions[ ]An array of questions within each cluster- \n
\nid:guid\n
\ntitle:string\n
\nreportingPeriodType:stringThe type of reporting period associated with the question. Can beYearlyMonthlyorAny\n
\ndisplayOrderIndex:intAn integer indicationg the display order of the question \n
\nisRequired:booleanA boolean that indicates whether the question is mandatory to answer. \n
\ndataPointClusters[ ]An array of data point clusters associated with each question- \n
\ntype:stringThe type of data point cluster. Can beQuestionorTable\n
\ndisplayOrderIndex:intAn integer indicating the display order of the data point cluster \n
\ndataPoints[ ]An array of data points within each cluster- \n
\nid:guid\n
\ntitle:string\n
\ninputType:stringInput type of the data point.Boolean,Integer,Decimal,Text,Date,DateRange,File,MultiSelectList,SingleSelectList\n
\nunitType:[DEPRECATED - useunitTypesinstead]. An object describing the unit of measurement for the data point if any- \n
\nid:guid\n
\nname:string\n
\n
\nunitTypes[ ]:An array ofunitType, each describing the unit of measurement relevant for this DataPoint. To know which units are in each unitType, you must refer to the/unit-typesendpoint.- \n
\nid:guid\n
\nname:stringName of the unit type. E.g.Volume,Energy,Mass,Area,GHG Emissions. \n
\n
\nallowedListValues[ ]An array of allowed values for list-type inputs- \n
\nid:guid\n
\ntitle:stringLabel of the allowed list value (e.g. \"Yes\") \n
\n
\nscoreCategories:[ ]- \n
\nid:guid\n
\nname:stringName of the category, e.g. \"Mandatory\" \n
\nattainableScore:numberMaximum score attainable by answering this data point within the score category \n
\n
\n
\n
\n
\n
\n
\n
\n
Get all unit types and units on BeCause.
\nResponse description:
\n- \n
\nunitTypes [ ]all unit types supported on BeCause- \n
\nId:guid\n
\nName:string\n
\nUnits [ ]list of units within this unit type:- \n
\nId:guid\n
\nName:string\n
\nAbbreviation:string\n
\n
\n
The endpoints included in this folder will help you get the accessible data and Ids needed for importing establishment data and performance answers.
\n","_postman_id":"83db308c-3dd6-4854-aa77-53c2aef8a5d3"},{"name":"Get status of your request","item":[{"name":"/bulk/status/{correlationId}","id":"581139c9-35c1-4bef-b5b2-7e676bcd4a25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"The response includes common fields for both types of imports, with specific result structures based on the request type.
\n- \n
The structure of this response may change, but the
\nstatusfield is expected to remain consistent. \nFor programmatic handling, it's recommended to primarily rely on the
\nstatusfield. \nIn case of
\nPartialSuccess, some rows may have succeeded while others failed, or a single row may have partially succeeded (e.g., company profile created but standard not assigned). \nDetailed error messages can be found in the
\nerrorobject for both import types. \n
Response description
\n- \n
\ncorrelationId:guidId of the request \n
\ncreatedAtUtc:dateCreation time of the request \n
\nupdatedAtUtc:dateLast update time of the request \n
\nstatus:enumOne of the following values:- \n
\nPending:Request has not started processing. \n
\nInProgress:A worker-node has picked up the request and started processing it. \n
\nCancelled:The request has been cancelled and will not continue. \n
\nSuccess:The import has finished, and a result is ready. No errors were encountered during the import. \n
\nPartialSuccess:The import has finished, and the result is ready, but one or more errors also occurred. These errors may be due to invalid input. See the error field for more details on the error that occurred. \n
\nerror:No result could be processed because one or more errors occurred. These errors may be due to invalid input or access issues. SeeErrorfor detailed error messages. \n
\n
\nrequestType:enumThe type of request, either holds the enum'ConsolidatedUpsertStandards'if request was made to the /bulk/consolidated/upsert-standards endpoint, or'BulkUpsertImportedAnswers'if request was made to the /bulk/performance-answers/upsert endpoint \n
\nresultContains the result of the request, the structure varies depending on therequestType\n
If requestType is BulkUpsertImportedAnswers the result object includes:
- \n
\nsuccessfulResults[ ]Contains the outcome of all successfully imported performance answers.- \n
\ndataPointId:guidThe id of the data point to which this result corresponds. \n
\ncustomIdentifier:stringCustom identifier value which identifies the company to which the result pertains. \n
\nsuccessType:enumCan have a value ofUpdatedorCreated, indicating whether a new answer has been added or an existing one has been updated. \n
\n
\nerrorContains the outcome of all unsuccessful imports.- \n
\nerrorResults[ ]Contains information about each data point that failed to import.- \n
\ndataPointId:guidThe id of the data point to which this result corresponds. \n
\ncustomIdentifier:stringCustom identifier value which identifies the company to which the result pertains. \n
\nmessage:stringDescription of error. \n
\n
\ngeneralErrorMessages[ ]Contains general error messages that do not relate to a specific submitted data point. \n
\n
If requestType is ConsolidatedUpsertStandards the result object includes:
- \n
\ncreateCompaniesResult- \n
\ncompanies[ ]- \n
\nbecauseProfileId:guidThe id of the company’s profile on BeCause \n
\ncustomIdentifiers[ ]Your custom identifiers for this profile on BeCause- \n
\nid:guidCustom identifier id \n
\nnameCustom identifer name (e.g. MyId) \n
\nvalueThe actual custom identifier value (e.g. \"12345\") \n
\n
\ninputIdentifier:Identifier (same as the input) \n
\nmatchResultTypeWhether the profile was created, updated, or retrieved (unchanged) \n
\n
\n
\nerror- \n
errorMessages:List of arbitrary error messages. \n
\n
Returns the status of a request corresponding to the provided correlationId. This endpoint is used to check the status of both establishment data imports and performance data imports.
The following sections describe how to use the BeCause.eco API for Certifiers. It focuses on three primary areas:
\n- \n
Importing establishment data
\n \nImporting performance answers
\n \nGetting the necessary data for imports
\n \n
The first endpoint is used to create or update company profiles on BeCause.eco, which is done by importing establishment data. The second endpoint is used to import performance answers for the created profiles. Additionally, we cover endpoints for retrieving necessary data and monitoring request status.
\n","_postman_id":"15f150f3-395c-4d8a-9f55-4fcc3cae3d01"}],"variable":[{"key":"baseUrl","value":"https://api.because.eco/api"}]}