v2 > Services > DeclarationsSearch


Search one or more declarations in Origin. The search result is organized in pages.

  • URL

    /connect/v2/declarations/search

  • Method:

    POST

  • URL Params

    none

  • Request :

Field Type Required Description Domain of value
locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
pageNumber number Yes The page number the search result will start from Positive integer greater than 0
pageSize number Yes The maximum number of result by page Integer between 1 and 100
contextCompanyOriginId string No The originId of a company (i.e. result.data[].company.originId in MaterialsSearch) A UUID
searchCriteria[] array of object Yes The list of search criteria SearchCriteria object array
searchCriteria[].name string Yes A criterion code supported by the search See the reference
searchCriteria[].value variable Yes The value to search See the reference
  • Sample Request :

This sample request could be translated as : "Search the declaration with ORIGINID value of db65ac6b-5850-11e8-803c-8c16451835eb starting from page 1 with 10 results by page."

{
    "locale": "en",
    "pageNumber": "1",
    "pageSize": "10",
    "searchCriteria": [
        {
            "name": "ORIGINID",
            "value": "db65ac6b-5850-11e8-803c-8c16451835eb"
        }
    ]
}
  • Response :
Field Type Presence Description Domain of value
status object Always The execution status A status object
status.state string Always The state of execution 'SUCCESS' or 'ERROR'
status.code string On error The general error code and message See Errors reference
status.messages[] array of string On error List of error causes A validation message or other causes
result object On success The execution result A result object
result.entityType string On success The type of entity this result is about 'DECLARATION'
result.searchInfo object On success Informations about the search result pages A searchInfo object
result.searchInfo.numberOfElements object On success The total number of elements found A positive integer
result.searchInfo.numberOfPages object On success The total number of pages NumberOfElements / pageSize
result.data[] array of declaration On success The actual search result : a list of declarations Array of declaration object
result.data[].locale string On success An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
result.data[].originId string On success The declaration unique origin ID A UUID
result.data[].externalId string On success The declaration unique ID in your system Any string
result.data[].declarationNumber string On success The number of the declaration Any string
result.data[].url string On success The URL to the declaration document A valid public facing URL
result.data[].additionalsDocuments[] array of object On success The additional documents Document object(s)
result.data[].additionalsDocuments[].originalUrl string On success The original URL of a document related to the declaration A valid public facing URL
result.data[].additionalsDocuments[].referenceUrl string On success URL of a document related to the declaration A valid public facing URL
result.data[].reportingBody object On success The reporting body A reporting body object
result.data[].reportingBody.name string On success The reporting body name An existing reporting body name in Origin. See data[].name ReportingBodiesLookup or any string for a custom reporting body.
result.data[].reportingBody.selfReported string On success The self reported flag A boolean value
result.data[].standard object On success The certified standard A standard object
result.data[].standard.code string On success The standard code data[].code StandardsLookup or any string for a custom standard.
result.data[].standard.name string On success The standard name Any string
result.data[].standard.isCustom string On success Flag to indicate whether the current standard is custom (not official) A boolean value
result.data[].issueDate date On success The date when the declaration is issued A ISO-8601 date
result.data[].expiryDate date On success The date when the declaration will be expired A ISO-8601 date
result.data[].brands[] array of brand On success The related brands Brand object(s)
result.data[].brands[].name string On success The brand name Any string
result.data[].brands[].website string On success The brand website A valid public facing URL
result.data[].contacts[] array of contact On success The related contacts Contact object(s)
result.data[].contacts[].externalId string On success A unique identifier of your choosing that serves as a unique key for the contact Any string
result.data[].contacts[].type string On success The contact type MANUFACTURER, AUDITOR or VENDOR
result.data[].contacts[].companyName string On success The contact company name Any string
result.data[].contacts[].phone string On success The contact phone Any string
result.data[].contacts[].email string On success The contact email A valid email
result.data[].contacts[].name string On success The contact name Any string
result.data[].contacts[].website string On success The contact website A valid public facing URL
result.data[].contacts[].postalAddress string On success The contact postal address Any string
result.data[].contacts[].location object On success The contact location Location object
result.data[].contacts[].location.city string On success The contact location city Any string
result.data[].contacts[].location.region string On success The contact location region Any string
result.data[].contacts[].location.country string On success The contact location country Any string
result.data[].regulatoryStandardCompliances[] array of object On success The regulatory standard compliances RegulatoryStandardCompliance Object(s)
result.data[].regulatoryStandardCompliances[].code string On success The standard code data[].code StandardsLookup
result.data[].featuresCustoms[] array of object On success The Custom features for the declaration Custom feature object(s)
result.data[].featuresCustoms[].originId string On success The custom feature unique origin ID A UUID
result.data[].featuresCustoms[].name string On success The custom feature name Any string
result.data[].featuresCustoms[].code string On success The custom feature property code CUSTOM_TEXT_ATTRIBUTE
result.data[].featuresCustoms[].value object On success The custom feature value Value object
result.data[].featuresCustoms[].value.content string On success The custom feature value content Any string
result.data[].featuresProperties[] array of object On success The feature properties for the declaration Feature property object(s)
result.data[].featuresProperties[].originId string On success The property feature unique origin ID A UUID
result.data[].featuresProperties[].code string On success The property feature code data[].standardProperties[].code in StandardsLookup
result.data[].featuresProperties[].name string On success The property feature name data[].standardProperties[].name in StandardsLookup
result.data[].featuresProperties[].value object On success The property feature value Value object
result.data[].featuresProperties[].value.code string On success The property feature value reference code possibleValues[].code in PropertyDetailsLookup
result.data[].featuresProperties[].value.content string On success The property feature value content Any string
result.data[].featuresProperties[].unit string On success The property feature unit Unit object
result.data[].featuresProperties[].unit.code string On success The property feature unit code possibleUnits[].code in PropertyDetailsLookup
result.data[].featuresProperties[].unit.name string On success The property feature unit name possibleUnits[].name in PropertyDetailsLookup
result.data[].voc object On success The VOC section VOC object
result.data[].voc.content object On success The VOC Content section VOC Content object
result.data[].voc.content.densityLimitGL string On success The density limit A decimal value
result.data[].voc.content.densityUnit object On success The density unit DensityUnit object
result.data[].voc.content.densityUnit.code string On success The density unit code data[].code in VOCUnitsLookup
result.data[].voc.content.densityUnit.name string On success The density unit name data[].name in VOCUnitsLookup
result.data[].voc.content.containsAddedMCPCE string On success Flag for intentionally added Methylene Chloride and/or Perchloroethylene A boolean value
result.data[].voc.content.regulatoryStandardCompliances[] array of object On success The list of compliant standards VOC Content compliance object(s)
result.data[].voc.content.regulatoryStandardCompliances[].standard string On success A compliant standard Standard object
result.data[].voc.content.regulatoryStandardCompliances[].standard.code string On success The standard code See the references
result.data[].voc.content.regulatoryStandardCompliances[].productTypeCode string On success The product type code See the references
result.data[].voc.content.regulatoryStandardCompliances[].productTypeName string On success The product type name Any string
result.data[].voc.content.regulatoryStandardCompliances[].productTypeDensityLimitGL string On success The product type density limit (g/L) A decimal value
result.data[].voc.content.regulatoryStandardCustoms[] array of object On success The list of custom standards Custom standard object(s)
result.data[].voc.content.regulatoryStandardCustoms[].standard object On success A custom standard Standard object
result.data[].voc.content.regulatoryStandardCustoms[].standard.code string On success The custom standard code Any string
result.data[].voc.content.testMethods[] array of object On success The list of standard test methods Test method object
result.data[].voc.content.testMethods[].standard object On success A test method standard Standard object
result.data[].voc.content.testMethods[].standard.code string On success The standard code See the references
result.data[].voc.content.exemptCompounds[] array of object On success The list of exempt compounds Exempt compound object(s)
result.data[].voc.content.exemptCompounds[].CAS string On success CAS registry number http://www.commonchemistry.org/
result.data[].voc.content.exemptCompounds[].name string On success Chemical name http://www.commonchemistry.org/
result.data[].voc.content.exemptCompounds[].percentByWeight string On success Composition percent by weight A decimal value
result.data[].voc.emission object On success The VOC Emission section VOC Emission object
result.data[].voc.emission.densityMin string On success Minimum density A decimal value
result.data[].voc.emission.densityMax string On success Maximum density A decimal value
result.data[].voc.emission.densityUnit object On success The density unit DensityUnit object
result.data[].voc.emission.densityUnit.code string On success The density unit code data[].code in VOCUnitsLookup
result.data[].voc.emission.densityUnit.name string On success The density unit name data[].name in VOCUnitsLookup
result.data[].voc.emission.regulatoryStandardCompliances[] array of object On success The list of compliant standard VOC Emission compliance object(s)
result.data[].voc.emission.regulatoryStandardCompliances[].standard object On success A compliant standard Standard object
result.data[].voc.emission.regulatoryStandardCompliances[].standard.code string On success The standard code See the references
result.data[].enhancedDeclaration object On success The enhanced data of the current declaration. By default, the service returns enhanced data added by your company. You can use the field contextCompanyOriginId to get the enhanced data added by another company. A declaration object
result.data[].enhancedDeclaration.originId string On success The declaration unique origin ID A UUID
result.data[].enhancedDeclaration.externalId string On success The declaration unique ID in your system Any string
result.data[].enhancedDeclaration.declarationNumber string On success The number of the declaration Any string
result.data[].enhancedDeclaration.url string On success The URL to the declaration document A valid public facing URL
result.data[].enhancedDeclaration.additionalsDocuments[] array of object On success The additional documents Document object(s)
result.data[].enhancedDeclaration.additionalsDocuments[].originalUrl string On success The original URL of a document related to the declaration A valid public facing URL
result.data[].enhancedDeclaration.additionalsDocuments[].referenceUrl string On success URL of a document related to the declaration A valid public facing URL
result.data[].enhancedDeclaration.issueDate date On success The date when the declaration is issued A ISO-8601 date
result.data[].enhancedDeclaration.expiryDate date On success The date when the declaration will be expired A ISO-8601 date
result.data[].enhancedDeclaration.regulatoryStandardCompliances[] array of object On success The regulatory standard compliances RegulatoryStandardCompliance Object(s)
result.data[].enhancedDeclaration.regulatoryStandardCompliances[].code string On success The standard code data[].code StandardsLookup
result.data[].enhancedDeclaration.featuresCustoms[] array of object On success The Custom features for the declaration Custom feature object(s)
result.data[].enhancedDeclaration.featuresCustoms[].originId string On success The custom feature unique origin ID A UUID
result.data[].enhancedDeclaration.featuresCustoms[].name string On success The custom feature name Any string
result.data[].enhancedDeclaration.featuresCustoms[].code string On success The custom feature property code CUSTOM_TEXT_ATTRIBUTE
result.data[].enhancedDeclaration.featuresCustoms[].value object On success The custom feature value Value object
result.data[].enhancedDeclaration.featuresCustoms[].value.content string On success The custom feature value content Any string
result.data[].enhancedDeclaration.featuresProperties[] array of object On success The feature properties for the declaration Feature property object(s)
result.data[].enhancedDeclaration.featuresProperties[].originId string On success The property feature unique origin ID A UUID
result.data[].enhancedDeclaration.featuresProperties[].code string On success The property feature code data[].standardProperties[].code in StandardsLookup
result.data[].enhancedDeclaration.featuresProperties[].name string On success The property feature name data[].standardProperties[].name in StandardsLookup
result.data[].enhancedDeclaration.featuresProperties[].value object On success The property feature value Value object
result.data[].enhancedDeclaration.featuresProperties[].value.code string On success The property feature value reference code possibleValues[].code in PropertyDetailsLookup
result.data[].enhancedDeclaration.featuresProperties[].value.content string On success The property feature value content Any string
result.data[].enhancedDeclaration.featuresProperties[].unit string On success The property feature unit Unit object
result.data[].enhancedDeclaration.featuresProperties[].unit.code string On success The property feature unit code possibleUnits[].code in PropertyDetailsLookup
result.data[].enhancedDeclaration.featuresProperties[].unit.name string On success The property feature unit name possibleUnits[].name in PropertyDetailsLookup
result.data[].enhancedDeclaration.voc object On success The VOC section VOC object
result.data[].enhancedDeclaration.voc.content object On success The VOC Content section VOC Content object
result.data[].enhancedDeclaration.voc.content.densityLimitGL string On success The density limit A decimal value
result.data[].enhancedDeclaration.voc.content.densityUnit object On success The density unit DensityUnit object
result.data[].enhancedDeclaration.voc.content.densityUnit.code string On success The density unit code data[].code in VOCUnitsLookup
result.data[].enhancedDeclaration.voc.content.densityUnit.name string On success The density unit name data[].name in VOCUnitsLookup
result.data[].enhancedDeclaration.voc.content.containsAddedMCPCE string On success Flag for intentionally added Methylene Chloride and/or Perchloroethylene A boolean value
result.data[].enhancedDeclaration.voc.content.regulatoryStandardCompliances[] array of object On success The list of compliant standards VOC Content compliance object(s)
result.data[].enhancedDeclaration.voc.content.regulatoryStandardCompliances[].standard string On success A compliant standard Standard object
result.data[].enhancedDeclaration.voc.content.regulatoryStandardCompliances[].standard.code string On success The standard code See the references
result.data[].enhancedDeclaration.voc.content.regulatoryStandardCompliances[].productTypeCode string On success The product type code See the references
result.data[].enhancedDeclaration.voc.content.regulatoryStandardCompliances[].productTypeName string On success The product type name Any string
result.data[].enhancedDeclaration.voc.content.regulatoryStandardCompliances[].productTypeDensityLimitGL string On success The product type density limit (g/L) A decimal value
result.data[].enhancedDeclaration.voc.content.regulatoryStandardCustoms[] array of object On success The list of custom standards Custom standard object(s)
result.data[].enhancedDeclaration.voc.content.regulatoryStandardCustoms[].standard object On success A custom standard Standard object
result.data[].enhancedDeclaration.voc.content.regulatoryStandardCustoms[].standard.code string On success The custom standard code Any string
result.data[].enhancedDeclaration.voc.content.testMethods[] array of object On success The list of standard test methods Test method object
result.data[].enhancedDeclaration.voc.content.testMethods[].standard object On success A test method standard Standard object
result.data[].enhancedDeclaration.voc.content.testMethods[].standard.code string On success The standard code See the references
result.data[].enhancedDeclaration.voc.content.exemptCompounds[] array of object On success The list of exempt compounds Exempt compound object(s)
result.data[].enhancedDeclaration.voc.content.exemptCompounds[].CAS string On success CAS registry number http://www.commonchemistry.org/
result.data[].enhancedDeclaration.voc.content.exemptCompounds[].name string On success Chemical name http://www.commonchemistry.org/
result.data[].enhancedDeclaration.voc.content.exemptCompounds[].percentByWeight string On success Composition percent by weight A decimal value
result.data[].enhancedDeclaration.voc.emission object On success The VOC Emission section VOC Emission object
result.data[].enhancedDeclaration.voc.emission.densityMin string On success Minimum density A decimal value
result.data[].enhancedDeclaration.voc.emission.densityMax string On success Maximum density A decimal value
result.data[].enhancedDeclaration.voc.emission.densityUnit object On success The density unit DensityUnit object
result.data[].enhancedDeclaration.voc.emission.densityUnit.code string On success The density unit code data[].code in VOCUnitsLookup
result.data[].enhancedDeclaration.voc.emission.densityUnit.name string On success The density unit name data[].name in VOCUnitsLookup
result.data[].enhancedDeclaration.voc.emission.regulatoryStandardCompliances[] array of object On success The list of compliant standard VOC Emission compliance object(s)
result.data[].enhancedDeclaration.voc.emission.regulatoryStandardCompliances[].standard object On success A compliant standard Standard object
result.data[].enhancedDeclaration.voc.emission.regulatoryStandardCompliances[].standard.code string On success The standard code See the references
connectRequest object Always The exact request sent that produced this response A DeclarationsSearch request
  • Sample Response (Success):

    HTTP Code : 200

{
  "status": {
    "state": "SUCCESS"
  },
  "result": {
    "entityType": "DECLARATION",
    "searchInfo": {
      "numberOfElements": "1",
      "numberOfPages": "1"
    },
    "data": [
      {
        "originId": "db65ac6b-5850-11e8-803c-8c16451835eb",
        "externalId": "123456789",
        "declarationNumber": "DEC-0001-2017",
        "url": "https://public.facing.url/declaration.pdf",
        "additionalsDocuments": [
          {
            "referenceUrl": "https://origin.build/equinox/storage/private/1000/100287398-image.jpg"
          }
        ],
        "reportingBody": {
          "selfReported": "false",
          "name": "Veritas"
        },
        "standard": {
          "code": "EPD",
          "name":"EPD"
        },
        "issueDate": "2008-09-15T19:53:00Z",
        "expiryDate": "2010-09-15T19:53:00Z",
        "brands": [
          {
            "name": "ACME Inc.",
            "website": "www.acmexyz.com"
          }
        ],
        "contacts": [
          {
            "externalId": "JOHNSMITHVENDOR1",
            "type": "VENDOR",
            "companyName": "ACME Inc.",
            "name": "John Smith",
            "website": "https://www.acme.com/",
            "postalAddress": "2500 Street Avenue P.O. Box 999 Manchester, PA 1234",
            "phone": "1-999-123-1234",
            "email": "salesrep@acme.com",
            "location": {
              "city": "Aix-en-Provence",
              "region": "Provence-Alpes-Côte d'Azur",
              "country": "France"
            }
        }
        ],
        "regulatoryStandardCompliances": [
          {
            "code": "ISO 9001"
          }
        ],
        "featuresCustoms": [
          {
            "originId": "ba3c67b7-8c32-497c-be37-1698d20b872d",
            "code": "CUSTOM_TEXT_ATTRIBUTE",
            "name": "Highest supported temperature",
            "value": {
              "content": "1500C"
            }
          }
        ],
        "featuresProperties": [
          {
            "originId": "ee6785ca-59d5-413d-a99c-697f84c16a02",
            "code": "LIFEEXPECTANCY",
            "name": "Life Expectancy",
            "value": {
              "content": "3"
            },
            "unit": {
              "code": "YEAR",
              "name": "Years"
            }
          },
          {
            "originId": "45994ea2-2f48-4c9c-aa93-ec27e2675a0d",
            "code": "FSC_LABEL_TYPE",
            "name": "FSC Label",
            "value": {
              "code": "FSC 100%",
              "content": "FSC 100%"
            }
          }
        ],
        "voc": {
          "content": {
            "densityLimitGL": "10",
            "densityUnit": {
              "code": "EM_GL",
              "name": "g/L"
            },
            "containsAddedMCPCE": "true",
            "regulatoryStandardCompliances": [
              {
                "standard": {
                  "code": "CARB SCM (2007)"
                },
                "productTypeCode": "Specialty Coatings - Bituminous Roof Coatings",
                "productTypeName": "Specialty Coatings - Bituminous Roof Coatings",
                "productTypeDensityLimitGL": "0.0042"
              }
            ],
            "regulatoryStandardCustoms": [
              {
                "standard": {
                  "code": "A CUSTOM CODE"
                }
              }
            ],
            "testMethods": [
              {
                "standard": {
                  "code": "ASTM Methods D2369"
                }
              }
            ],
            "exemptCompounds": [
              {
                "CAS": "142731-63-32",
                "name": "TRANS-3-HEPTENE",
                "percentByWeight": "1.9"
              }
            ]
          },
          "emission": {
            "densityMin": "250",
            "densityMax": "500",
            "densityUnit": {
              "code": "EM_UGM3",
              "name": "ug/m3"
            },
            "regulatoryStandardCompliances": [
              {
                "standard": {
                  "code": "Blue Angel Elastic Floorings"
                }
              }
            ]
          }
        },
        "enhancedDeclaration": {
          "originId": "989a0684-824e-4c7f-b0e3-eb6d25badcdb",
          "declarationNumber": "ENH-D-1234",
          "url": "https://public.facing.url/enhanced_declaration.pdf",
          "additionalsDocuments": [
            {
              "referenceUrl": "https://origin.build/equinox/storage/private/1000/100287398-image.jpg"
            }
          ],
          "issueDate": "2029-12-31T19:00:00-05:00",
          "expiryDate": "2030-12-25T00:00:00Z",
          "regulatoryStandardCompliances": [
            {
              "code": "Blue Angel Flooring Underlays (cushion)"
            }
          ],
          "featuresCustoms": [
            {
              "originId": "5e3ceef2-b68a-464a-b68f-dcda6cc072c3",
              "code": "CUSTOM_TEXT_ATTRIBUTE",
              "name": "Highest supported temperature",
              "value": {
                "content": "1600C"
              }
            }
          ],
          "featuresProperties": [
            {
              "originId": "4fef8341-92a0-4e35-b09d-ae9713a66aae",
              "code": "LIFEEXPECTANCY",
              "name": "Life Expectancy",
              "value": {
                "content": "2"
              },
              "unit": {
                "code": "YEAR",
                "name": "Years"
              }
            }
          ],
          "voc": {
            "content": {
              "densityLimitGL": "120",
              "densityUnit": {
                "code": "EM_UGM3",
                "name": "ug/m3"
              },
              "containsAddedMCPCE": "true",
              "regulatoryStandardCompliances": [
                {
                  "standard": {
                    "code": "Canadian VOC Concentration Limits for Architectural Coatings"
                  },
                  "productTypeName": "Antenna coating",
                  "productTypeCode": "Antenna coating",
                  "productTypeDensityLimitGL": "530"
                }
              ],
              "testMethods": [
                {
                  "standard": {
                    "code": "Calculated from formulation"
                  }
                }
              ],
              "exemptCompounds": [
                {
                  "CAS": "10022-68-1",
                  "name": "Cadmium Nitrate, 4-Hydrate",
                  "percentByWeight": "0.0001"
                }
              ]
            },
            "emission": {
              "densityMin": "120.0002",
              "densityMax": "120.00033",
              "densityUnit": {
                "code": "EM_MGM2H",
                "name": "mg/m2*h"
              },
              "regulatoryStandardCompliances": [
                {
                  "standard": {
                    "code": "CDPH Standard Method 2010 v1.1"
                  }
                }
              ]
            }
          }
        }
      }
    ]
  },
  "connectRequest": {
    "locale": "en",
    "pageNumber": "1",
    "pageSize": "1",
    "searchCriteria": [
      {
        "name": "ORIGINID",
        "value": "db65ac6b-5850-11e8-803c-8c16451835eb"
      }
    ]
  }
}
  • Sample Response (Error):

    HTTP Code : 400, 500

{
    "status": {
        "state": "ERROR",
        "code": "CE00001 - Connect request failed validation. Refer to provided messages for details.",
        "messages": [
            "Request has invalid value '0' for field pageNumber. Allowed value(s) : [positive integer not equal zero]",
            "searchCriteria[1] has invalid value 'ORIGIN_IDENT' for field name. Allowed value(s) : [ORIGINID,EXTERNALID]"
        ]
    },
    "connectRequest": {
        "locale": "en",
        "pageNumber": "0",
        "pageSize": "1",
        "searchCriteria": [
            {
                "name": "ORIGIN_IDENT",
                "value": "db65ac6b-5850-11e8-803c-8c16451835eb"
            }
        ]
    }
}

results matching ""

    No results matching ""