v1 > Services > CertificationsUpdate

Update one or more certifications in Origin.

  • URL

    /connect/v1/certifications/update

    /connect/v1/async/certifications/update

  • Method:

    POST

  • URL Params

    none

  • Request :

Field Type Required Description Domain of value
certifications[] array of object At least one The list of certifications to update Certification object(s)
certifications[].locale string Yes An Origin supported locale 'de', 'es_MX', 'en', 'fr' or 'zh_CN'
certifications[].originId string Only if no certifications[].externalId The certification unique origin ID Any string
certifications[].externalId string Only if no certifications[].originId The certification unique ID in your system Any string
certifications[].certificateNumber string No The number of the certificate Any string
certifications[].url string No The URL to the certificate document A valid public facing URL
certifications[].additionalsDocuments[] array of object No The additional documents Document object(s)
certifications[].additionalsDocuments[].collectionBehavior string Only if certifications[].additionalsDocuments[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
certifications[].additionalsDocuments[].originalUrl string Only if certifications[].additionalsDocuments[] is present URL of a document related to the certification A valid public facing URL
certifications[].reportingBody object No The reporting body A reporting body object
certifications[].reportingBody.name string Only allowed when certifications[].reportingBody.selfReported is absent The reporting body name. Remove self reported status if set. An existing reporting body name in Origin
certifications[].reportingBody.selfReported string Only allowed when certifications[].reportingBody.name is absent Set the certification as self reported. Erase existing reporting name if any. TRUE
certifications[].standard object No The certified standard Standard object
certifications[].standard.code string Only if certifications[].standard is present The standard code See StandardsLookup for a list of possible values
certifications[].issueDate date No The date when the certification is issued A ISO-8601 date
certifications[].expiryDate date No The date when the certification will be expired A ISO-8601 date
certifications[].brands[] array of brand No The related brands Brand object(s)
certifications[].brands[].collectionBehavior string Only if certifications[].brands[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
certifications[].brands[].name string Only if certifications[].brands[] is present The brand name Any string
certifications[].brands[].website string No The brand website A valid public facing URL
certifications[].contacts[] array of contact No The related contacts Contact object(s)
certifications[].contacts[].collectionBehavior string Only if certifications[].contacts[] is present The way the current collection element is updated.ADD will update attribute of existing element. ADD, REMOVE
certifications[].contacts[].externalId string Only if certifications[].contacts[] is present A unique identifier of your choosing that serves as a unique key for the contact Any string
certifications[].contacts[].type string No The contact type MANUFACTURER, AUDITOR or VENDOR
certifications[].contacts[].companyName string No The contact company name Any string
certifications[].contacts[].phone string No The contact phone Any string
certifications[].contacts[].email string No The contact email A valid email
certifications[].contacts[].name string No The contact name Any string
certifications[].contacts[].website string No The contact website A valid public facing URL
certifications[].contacts[].postalAddress string No The contact postal address Any string
certifications[].channels[] array of object No The list of channels on which the certification will be published Channel object(s). Not published if empty.
certifications[].channels[].collectionBehavior string Only if certifications[].channels[] is present The way the current collection element is updated. ADD publish the certification, REMOVE will unpublish it. ADD, REMOVE
certifications[].channels[].name string Only if certifications[].channels[] is present The channel name 'ORIGIN' (more to come)
certifications[].regulatoryStandardCompliances[] array of object no The regulatory standard compliances RegulatoryStandardCompliance Object(s)
certifications[].regulatoryStandardCompliances[].collectionBehavior string Only if certifications[].regulatoryStandardCompliances[] is present The way the current collection element is updated.ADD will update attribute of existing element. ADD, REMOVE
certifications[].regulatoryStandardCompliances[].code string Only if certifications[].regulatoryStandardCompliances[] The standard code See standardProperties in StandardsLookup for a list of possible values
certifications[].featuresCustoms[] array of object No The list of Origin Customs features Custom feature object(s)
certifications[].featuresCustoms[].collectionBehavior string Only if certifications[].featuresCustoms[] is present The way the current collection element is updated.ADD will update attribute of existing element. ADD, REMOVE
certifications[].featuresCustoms[].name string Only if certifications[].featuresCustoms[] is present The Custom feature name Any string
certifications[].featuresCustoms[].value string Only if certifications[].featuresCustoms[] is present The Custom feature value Any string
certifications[].featuresProperties[] array of object No The list of Origin Properties features Feature property object(s)
certifications[].featuresProperties[].collectionBehavior string Only if certifications[].featuresProperties[] is present The way the current collection element is updated.ADD will update attribute of existing element. ADD, REMOVE
certifications[].featuresProperties[].code string Only if certifications[].featuresProperties[] is present The feature property code See standardProperties in StandardsLookup for a list of possible values
certifications[].featuresProperties[].value string Only if certifications[].featuresProperties[] is present The feature property value See PropertyDetailsLookup for a list of possible values
certifications[].voc object no The VOC section VOC object
certifications[].voc.content object no The VOC Content section VOC Content object
certifications[].voc.content.densityLimitGL string no The density limit (g/L) A decimal value
certifications[].voc.content.containsAddedMCPCE string no Flag for intentionally added Methylene Chloride and/or Perchloroethylene A boolean value
certifications[].voc.content.regulatoryStandardCompliances[] array of object Only if certifications[].voc.content.densityLimitGL is set The list of compliant standards VOC Content compliance object(s)
certifications[].voc.content.regulatoryStandardCompliances[].collectionBehavior string only if certifications[].voc.content.regulatoryStandardCompliances[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
certifications[].voc.content.regulatoryStandardCompliances[].standard string only if certifications[].voc.content.regulatoryStandardCompliances[] is present A compliant standard Standard object
certifications[].voc.content.regulatoryStandardCompliances[].standard.code string only if certifications[].voc.content.regulatoryStandardCompliances[] is present The standard code See VOC Content standard compliances for a list of possible values
certifications[].voc.content.regulatoryStandardCompliances[].productTypeCode string only if certifications[].voc.content.regulatoryStandardCompliances[] is present The product type code See VOC Content standard compliances for a list of possible values
certifications[].voc.content.regulatoryStandardCustoms[] array of object no The list of custom standards Custom standard object(s)
certifications[].voc.content.regulatoryStandardCustoms[].collectionBehavior string only if certifications[].voc.content.regulatoryStandardCustoms[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
certifications[].voc.content.regulatoryStandardCustoms[].standard object only if certifications[].voc.content.regulatoryStandardCustoms[] is present A custom standard Standard object
certifications[].voc.content.regulatoryStandardCustoms[].standard.code string only if certifications[].voc.content.regulatoryStandardCustoms[] is present The custom standard code Any string
certifications[].voc.content.testMethods[] array of object no The list of standard test methods Test method object(s)
certifications[].voc.content.testMethods[].collectionBehavior string only if certifications[].voc.content.regulatoryStandardCompliances[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
certifications[].voc.content.testMethods[].standard object only if certifications[].voc.content.testMethods[] is present A test method standard A standard object
certifications[].voc.content.testMethods[].standard.code string only if certifications[].voc.content.testMethods[] is present The standard code See VOC Content test methods for a list of possible values
certifications[].voc.content.exemptCompounds[] array of object no The list of exempt compounds Exempt compound object(s)
certifications[].voc.content.exemptCompounds[].collectionBehavior string only if certifications[].voc.content.exemptCompounds[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
certifications[].voc.content.exemptCompounds[].CAS string only if certifications[].voc.content.exemptCompounds[] is present CAS registry number http://www.commonchemistry.org/
certifications[].voc.content.exemptCompounds[].name string only if certifications[].voc.content.exemptCompounds[] is present Chemical name http://www.commonchemistry.org/
certifications[].voc.content.exemptCompounds[].percentByWeight string only if certifications[].voc.content.exemptCompounds[] is present Composition percent by weight A decimal value
certifications[].voc.emission object no The VOC Emission section VOC Emission object
certifications[].voc.emission.densityMin string no Minimum density in microgram per cubic meter (µg/m³) A decimal value
certifications[].voc.emission.densityMax string no Maximum density in microgram per cubic meter (µg/m³) A decimal value
certifications[].voc.emission.regulatoryStandardCompliances[] array of object no The list of compliant standard VOC Emission compliance object(s)
certifications[].voc.emission.regulatoryStandardCompliances[].collectionBehavior string only if certifications[].voc.emission.exemptCompounds[] is present The way the current collection element is updated. ADD will update attribute of existing element. ADD, REMOVE
certifications[].voc.emission.regulatoryStandardCompliances[].standard object only if certifications[].voc.emission.regulatoryStandardCompliances[] is present A compliant standard Standard object
certifications[].voc.emission.regulatoryStandardCompliances[].standard.code string only if certifications[].voc.emission.regulatoryStandardCompliances[] is present The standard code See VOC Emission standard compliances for a list of possible values
  • Sample Request (Update of certifications attributes):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "url":"https://public.facing.url/certificate.pdf",
      "certificateNumber":"123456",
      "issueDate":"2008-09-15T15:53:00",
      "expiryDate":"2010-09-15T15:53:00"
    }
  ]
}
  • Sample Request (Update of standard):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "standard":{
        "code":"ISO 9001"
      }
    }
  ]
}
  • Sample Request (Update of reporting body):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "reportingBody":{
        "name":"Veritas"
      }
    }
  ]
}
  • Sample Request (Update the certification by ADDING a brand):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "brands":[
        {
          "collectionBehavior":"ADD",
          "name":"ACME Inc.",
          "website":"www.acmexyz.com"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by UPDATING a brand website):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
       "brands":[
        {
          "collectionBehavior":"ADD",
          "name":"ACME Inc.",
          "website":"www.acmexyz-2000.com"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by REMOVING a brand.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "brands":[
        {
          "collectionBehavior":"REMOVE",
          "name":"ACME Inc."
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by ADDING a contact):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "contacts":[
        {
          "collectionBehavior":"ADD",
          "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"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by UPDATING a contact website):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "contacts":[
        {
          "collectionBehavior":"ADD",
          "externalId":"JOHNSMITHVENDOR1",
          "website":"https://www.acme-2000.com/"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by REMOVING a contact):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "contacts":[
        {
          "collectionBehavior":"REMOVE",
          "externalId":"JOHNSMITHVENDOR1"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by ADDING a document):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "additionalsDocuments":[
        {
          "collectionBehavior":"ADD",
          "originalUrl":"https://public.facing.url/image.jpg"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by REMOVING a document):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "additionalsDocuments":[
        {
          "collectionBehavior":"REMOVE",
          "originalUrl":"https://public.facing.url/image.jpg"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification visibility. ADD channel = PUBLISH on that channel):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "channels":[
        {
          "collectionBehavior":"ADD",
          "name":"ORIGIN"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification visibility. REMOVE channel = UNPUBLISH from that channel):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "channels":[
        {
          "collectionBehavior":"REMOVE",
          "name":"ORIGIN"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by ADDING a regulatory standard compliance):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "regulatoryStandardCompliances":[
        {
          "collectionBehavior":"ADD",
          "code":"ISO 9001"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by REMOVING a regulatory standard compliance):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "regulatoryStandardCompliances":[
        {
          "collectionBehavior":"REMOVE",
          "code":"ISO 9001"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by ADDING a custom feature):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "featuresCustoms":[
        {
          "collectionBehavior":"ADD",
          "name":"Highest supported temperature",
          "value":"1500C"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by UPDATING a custom feature.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "featuresCustoms":[
        {
          "collectionBehavior":"ADD",
          "name":"Highest supported temperature",
          "value":"2000C"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification by REMOVING a custom feature.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "featuresCustoms":[
        {
          "collectionBehavior":"REMOVE",
          "name":"Highest supported temperature"
        }
      ]
    }
  ]
}
  • Sample Request (Update the certification voc content by UPDATING its attributes.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "densityLimitGL":"40",
          "containsAddedMCPCE":"true"
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc content by ADDING a regulatory standard compliance.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"Hong Kong Air Pollution Control (VOC) regulation"
              },
              "productTypeCode":"Graphic arts (sign) coatings"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc content by REMOVING a regulatory standard compliance.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"Hong Kong Air Pollution Control (VOC) regulation"
              },
              "productTypeCode":"Graphic arts (sign) coatings"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc content by ADDING a custom standard compliance.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCustoms":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"A CUSTOM CODE"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc content by REMOVING a custom standard compliance.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "regulatoryStandardCustoms":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"A CUSTOM CODE"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc content by ADDING a test method.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "testMethods":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"ASTM Methods D2369"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc content by REMOVING a test method.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "testMethods":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"ASTM Methods D2369"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc content by ADDING an exempt compound.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "exemptCompounds":[
            {
              "collectionBehavior":"ADD",
              "CAS":"109-99-9",
              "name":"Tetrahydrofuran",
              "percentByWeight":"1"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc content by UPDATING an exempt compound attributes.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "exemptCompounds":[
            {
              "collectionBehavior":"ADD",
              "CAS":"109-99-9",
              "name":"Tetrahydrofuran",
              "percentByWeight":"1.5"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc content by REMOVING an exempt compound.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"f5a645f9-57dc-4ae1-9bc8-a0410e3a1f17",
      "voc":{
        "content":{
          "exemptCompounds":[
            {
              "collectionBehavior":"REMOVE",
              "CAS":"109-99-9"
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc emission by UPDATING its attributes.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"fe61dc5b-4c5c-4331-8ca8-45ce264f68f3",
      "voc":{
        "emission":{
          "densityMinGL":"250",
          "densityMaxGL":"500",        
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc emission by ADDING a regulatory standard compliance.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"fe61dc5b-4c5c-4331-8ca8-45ce264f68f3",
      "voc":{
        "emission":{
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"CDPH Standard Method 2010 v1.1"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (Update the certification voc emission by REMOVING a regulatory standard compliance.):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"fe61dc5b-4c5c-4331-8ca8-45ce264f68f3",
      "voc":{
        "emission":{
          "densityMinGL":"250",
          "densityMaxGL":"500",
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"REMOVE",
              "standard":{
                "code":"CDPH Standard Method 2010 v1.1"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Sample Request (All fields):
{
  "certifications":[
    {
      "locale":"en",
      "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
      "certificateNumber":"ABC-123-000001",
      "url":"https://public.facing.url/certificate.pdf",
      "issueDate":"2008-09-15T15:53:00",
      "expiryDate":"2010-09-15T15:53:00",
      "additionalsDocuments":[
        {
          "collectionBehavior":"ADD",
          "originalUrl":"https://public.facing.url/image.jpg"
        }
      ],
      "regulatoryStandardCompliances":[
        {
          "code":"ISO 9001"
        }
      ],
      "reportingBody":{
        "name":"Veritas"
      },
      "standard":{
        "code":"EPD"
      },
      "brands":[
        {
          "collectionBehavior":"ADD",
          "name":"ACME Inc.",
          "website":"www.acmexyz.com"
        }
      ],
      "contacts":[
        {
          "collectionBehavior":"ADD",
          "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"
        }
      ],
      "channels":[
        {
          "collectionBehavior":"ADD",
          "name":"ORIGIN"
        }
      ],
      "featuresCustoms":[
        {
          "collectionBehavior":"ADD",
          "name":"Highest supported temperature",
          "value":"1500C"
        }
      ],
      "featuresProperties":[
        {
          "collectionBehavior":"ADD",
          "code":"EPD_TYPE",
          "value":"product-specific"
        }
      ],
      "voc":{
        "content":{
          "densityLimitGL":"10",
          "containsAddedMCPCE":"true",
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"CARB SCM (2007)"
              },
              "productTypeCode":"Specialty Coatings - Bituminous Roof Coatings"
            }
          ],
          "regulatoryStandardCustoms":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"A CUSTOM CODE"
              }
            }
          ],
          "testMethods":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"ASTM Methods D2369"
              }
            }
          ],
          "exemptCompounds":[
            {
              "collectionBehavior":"ADD",
              "CAS":"142731-63-32",
              "name":"TRANS-3-HEPTENE",
              "percentByWeight":"1.9"
            }
          ]
        },
        "emission":{
          "densityMin":"250",
          "densityMax":"500",
          "regulatoryStandardCompliances":[
            {
              "collectionBehavior":"ADD",
              "standard":{
                "code":"Blue Angel Elastic Floorings"
              }
            }
          ]
        }
      }
    }
  ]
}
  • Response (sync mode) :
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.result object On success A simple completion message 'Update completed.'
connectRequest object Always The exact request sent that produced this response A CertificationsUpdate request

  • Sample Response (Success in sync mode):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "entityType":"CERTIFICATION",
    "result":"Update completed."
  },
  "connectRequest":{
    "certifications":[
      {
        "locale":"en",
        "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
        "url":"https://public.facing.url/certificate.pdf"
      }
    ]
  }
}
  • Response (async mode):
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 errors causes A validation message or other causes
result object On success The execution result A result object
result.poolingCallback string On success The URL callback to pool using the ResultGet endpoint A URL
connectRequest object Always The exact request you sent that produced this response A CertificationsCreate request

  • Sample Response (Success in async mode):

    HTTP Code : 200

{
  "status":{
    "state":"SUCCESS"
  },
  "result":{
    "poolingCallback":"https://origin.build/equinox/connect/v1/result/certifications_update/batch/1c8a06b6-45be-4e68-9e2d-5c1f075e6ca2"
  },
  "connectRequest":{
    "certifications":[
      {
        "locale":"en",
        "originId":"13949a9b-ee17-4760-93e9-7749ff2faa79",
        "url":"https://public.facing.url/certificate.pdf"
      }
    ]
  }
}

  • Sample Response (Error):

    HTTP Code : 400, 500

{
  "status":{
    "state":"ERROR",
    "code":"CE00001 - Connect request failed validation. Refer to provided messages for details.",
    "messages":[
      "certifications[1] require one locale.",
      "certifications[1] require one originId or externalId.",
      "certifications[1] has invalid value ''ADD ITEM'' for field contact[1].collectionBehavior. Allowed value(s) : [ADD,REMOVE]",
      "certifications[1] require one externalId"
    ]
  },
  "connectRequest":{
    "certifications":[
      {
        "url":"https://public.facing.url/certificate.pdf",
        "contacts":{
          "collectionBehavior":"ADD ITEM",
          "name":"Jack Smith"
        }
      }
    ]
  }
}

results matching ""

    No results matching ""