v1 > Services > CertificationsSearch


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

  • URL

    /connect/v1/certifications/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 certification 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 'CERTIFICATION'
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 certification On success The actual search result : a list of certifications Array of certification 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 certification unique origin ID A UUID
result.data[].externalId string On success The certification unique ID in your system Any string
result.data[].certificateNumber string On success The number of the certificate Any string
result.data[].url string On success The URL to the certificate 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 certification A valid public facing URL
result.data[].additionalsDocuments[].referenceUrl string On success URL of a document related to the certification 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 is not self reported An existing reporting body name in Origin
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 An existing standard code in Origin
result.data[].standard.name string On success The standard name Any string
result.data[].issueDate date On success The date when the certification is issued A ISO-8601 date
result.data[].expiryDate date On success The date when the certification 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[].regulatoryStandardCompliances[] array of object On success The regulatory standard compliances RegulatoryStandardCompliance Object(s)
result.data[].regulatoryStandardCompliances[].code string On success The standard code See standardProperties in StandardsLookup for a list of possible values
result.data[].featuresCustoms[] array of object On success The list of Origin Customs features Custom feature object(s)
result.data[].featuresCustoms[].name string On success The Custom feature name Any string
result.data[].featuresCustoms[].value string On success The Custom feature value Any string
result.data[].featuresProperties[] array of object On success The list of Origin Properties features Feature property object(s)
result.data[].featuresProperties[].name string On success The feature property name Any string
result.data[].featuresProperties[].value string On success The feature property value Any string
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 (g/L) A decimal value
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 VOC Content standard compliances for a list of possible values
result.data[].voc.content.regulatoryStandardCompliances[].productTypeCode string On success The product type code See VOC Content standard compliances for a list of possible values
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 VOC Content test methods for a list of possible values
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 in microgram per cubic meter (µg/m³) A decimal value
result.data[].voc.emission.densityMax string On success Maximum density in microgram per cubic meter (µg/m³) A decimal value
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 VOC Emission standard compliances for a list of possible values
result.data[].enhancedCertification object On success The enhanced data of the current certification. 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 certification object
result.data[].enhancedCertification.originId string On success The certification unique origin ID A UUID
result.data[].enhancedCertification.externalId string On success The certification unique ID in your system Any string
result.data[].enhancedCertification.certificateNumber string On success The number of the certificate Any string
result.data[].enhancedCertification.url string On success The URL to the certificate document A valid public facing URL
result.data[].enhancedCertification.additionalsDocuments[] array of object On success The additional documents Document object(s)
result.data[].enhancedCertification.additionalsDocuments[].originalUrl string On success The original URL of a document related to the certification A valid public facing URL
result.data[].enhancedCertification.additionalsDocuments[].referenceUrl string On success URL of a document related to the certification A valid public facing URL
result.data[].enhancedCertification.issueDate date On success The date when the certification is issued A ISO-8601 date
result.data[].enhancedCertification.expiryDate date On success The date when the certification will be expired A ISO-8601 date
result.data[].enhancedCertification.regulatoryStandardCompliances[] array of object On success The regulatory standard compliances RegulatoryStandardCompliance Object(s)
result.data[].enhancedCertification.regulatoryStandardCompliances[].code string On success The standard code See standardProperties in StandardsLookup for a list of possible values
result.data[].enhancedCertification.featuresCustoms[] array of object On success The list of Origin Customs features Custom feature object(s)
result.data[].enhancedCertification.featuresCustoms[].name string On success The Custom feature name Any string
result.data[].enhancedCertification.featuresCustoms[].value string On success The Custom feature value Any string
result.data[].enhancedCertification.featuresProperties[] array of object On success The list of Origin Properties features Feature property object(s)
result.data[].enhancedCertification.featuresProperties[].name string On success The feature property name Any string
result.data[].enhancedCertification.featuresProperties[].value string On success The feature property value Any string
result.data[].enhancedCertification.voc object On success The VOC section VOC object
result.data[].enhancedCertification.voc.content object On success The VOC Content section VOC Content object
result.data[].enhancedCertification.voc.content.densityLimitGL string On success The density limit (g/L) A decimal value
result.data[].enhancedCertification.voc.content.containsAddedMCPCE string On success Flag for intentionally added Methylene Chloride and/or Perchloroethylene A boolean value
result.data[].enhancedCertification.voc.content.regulatoryStandardCompliances[] array of object On success The list of compliant standards VOC Content compliance object(s)
result.data[].enhancedCertification.voc.content.regulatoryStandardCompliances[].standard string On success A compliant standard Standard object
result.data[].enhancedCertification.voc.content.regulatoryStandardCompliances[].standard.code string On success The standard code See VOC Content standard compliances for a list of possible values
result.data[].enhancedCertification.voc.content.regulatoryStandardCompliances[].productTypeCode string On success The product type code See VOC Content standard compliances for a list of possible values
result.data[].enhancedCertification.voc.content.regulatoryStandardCompliances[].productTypeName string On success The product type name Any string
result.data[].enhancedCertification.voc.content.regulatoryStandardCompliances[].productTypeDensityLimitGL string On success The product type density limit (g/L) A decimal value
result.data[].enhancedCertification.voc.content.regulatoryStandardCustoms[] array of object On success The list of custom standards Custom standard object(s)
result.data[].enhancedCertification.voc.content.regulatoryStandardCustoms[].standard object On success A custom standard Standard object
result.data[].enhancedCertification.voc.content.regulatoryStandardCustoms[].standard.code string On success The custom standard code Any string
result.data[].enhancedCertification.voc.content.testMethods[] array of object On success The list of standard test methods Test method object
result.data[].enhancedCertification.voc.content.testMethods[].standard object On success A test method standard Standard object
result.data[].enhancedCertification.voc.content.testMethods[].standard.code string On success The standard code See VOC Content test methods for a list of possible values
result.data[].enhancedCertification.voc.content.exemptCompounds[] array of object On success The list of exempt compounds Exempt compound object(s)
result.data[].enhancedCertification.voc.content.exemptCompounds[].CAS string On success CAS registry number http://www.commonchemistry.org/
result.data[].enhancedCertification.voc.content.exemptCompounds[].name string On success Chemical name http://www.commonchemistry.org/
result.data[].enhancedCertification.voc.content.exemptCompounds[].percentByWeight string On success Composition percent by weight A decimal value
result.data[].enhancedCertification.voc.emission object On success The VOC Emission section VOC Emission object
result.data[].enhancedCertification.voc.emission.densityMin string On success Minimum density in microgram per cubic meter (µg/m³) A decimal value
result.data[].enhancedCertification.voc.emission.densityMax string On success Maximum density in microgram per cubic meter (µg/m³) A decimal value
result.data[].enhancedCertification.voc.emission.regulatoryStandardCompliances[] array of object On success The list of compliant standard VOC Emission compliance object(s)
result.data[].enhancedCertification.voc.emission.regulatoryStandardCompliances[].standard object On success A compliant standard Standard object
result.data[].enhancedCertification.voc.emission.regulatoryStandardCompliances[].standard.code string On success The standard code See VOC Emission standard compliances for a list of possible values
connectRequest object Always The exact request sent that produced this response A CertificationsSearch request
  • Sample Response (Success):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"CERTIFICATION",
    "searchInfo":{
      "numberOfElements":"1",
      "numberOfPages":"1"
    },
    "data":[
      {
        "originId":"db65ac6b-5850-11e8-803c-8c16451835eb",
        "externalId":"db65ac67-5850-11e8-803c-8c16451835eb",
        "certificateNumber":"CERT-0001-2017",
        "url":"https://public.facing.url/certificate.pdf",
        "additionalsDocuments":[
          {
            "referenceUrl":"https://origin.build/equinox/storage/private/1000/100287398-image.jpg"
          }
        ],
        "reportingBody":{
          "selfReported": "false",
          "name":"Veritas"
        },
        "standard":{
          "code":"BkA-CC-01",
          "name":"BkA CC 01"
        },
        "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"
          }
        ],
        "regulatoryStandardCompliances":[
          {
            "code":"ISO 9001"
          }
        ],
        "featuresCustoms":[
          {
            "name":"C1",
            "value":"CV1"
          }
        ],
        "featuresProperties":[
          {
            "name":"Compliance with VOC Emissions Standards",
            "value":"CDPH Standard Method v1.1-2010"
          },
          {
            "name":"VOC Emissions (ug/m3)",
            "value":"23"
          }
        ],
        "voc":{
          "content":{
            "densityLimitGL":"10",
            "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",
            "regulatoryStandardCompliances":[
              {
                "standard":{
                  "code":"Blue Angel Elastic Floorings"
                }
              }
            ]
          }
        },
        "enhancedCertification": {
          "originId": "989a0684-824e-4c7f-b0e3-eb6d25badcdb",
          "certificateNumber": "ENH-C-1234",
          "url": "https://public.facing.url/enhanced_certificate.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": [
            {
              "name": "an enhanced custom name",
              "value": "an enhanced custom value"
            }
          ],
          "featuresProperties":[
            {
              "name":"VOC Emissions (ug/m3)",
              "value":"18"
            }
          ],
          "voc": {
            "content": {
              "densityLimitGL": "120",
              "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",
              "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 ""