Skip to main content
Version: Next

Post step results for reserved golden record tasks in the given step queue​

Post business partner step results for the given tasks in the given step queue. In order to post a result for a task it needs to be reserved first, has to currently be in the given step queue and the time limit is not exceeded. The number of results you can post at a time does not need to match the original number of reserved tasks. Results are accepted via strategy 'all or nothing'. For a single request, the maximum number of postable results is limited to 100.

Request Body required
  • step string required

    Possible values: [CleanAndSync, PoolSync, Clean]

    The step queue containing the tasks for which results are posted

  • results object[] required
  • taskId string required

    The identifier of the task for which this is a result

  • businessPartner object required

    The business partner data to be processed

  • nameParts object[] required
  • name string required
  • type string required

    Possible values: [LegalName, ShortName, LegalForm, SiteName, AddressName]

  • owningCompany string
  • uncategorized object required
  • nameParts string[] required
  • identifiers object[] required
  • value string
  • type string
  • issuingBody string
  • states object[] required
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • address object
  • bpnReference object required
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[] required
  • value string
  • type string
  • issuingBody string
  • states object[] required
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object required
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object required
  • geographicCoordinates object required
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object required
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • taxJurisdictionCode string
  • alternativeAddress object
  • geographicCoordinates object required
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • legalEntity object required
  • bpnReference object required
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • legalName string
  • legalShortName string
  • legalForm string
  • identifiers object[] required
  • value string
  • type string
  • issuingBody string
  • states object[] required
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object required
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • isCatenaXMemberData boolean
  • hasChanged boolean
  • legalAddress object required
  • bpnReference object required
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[] required
  • value string
  • type string
  • issuingBody string
  • states object[] required
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object required
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object required
  • geographicCoordinates object required
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object required
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • taxJurisdictionCode string
  • alternativeAddress object
  • geographicCoordinates object required
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • site object
  • bpnReference object required
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • siteName string
  • states object[] required
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object required
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • hasChanged boolean
  • siteMainAddress object
  • bpnReference object required
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[] required
  • value string
  • type string
  • issuingBody string
  • states object[] required
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object required
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object required
  • geographicCoordinates object required
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object required
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • taxJurisdictionCode string
  • alternativeAddress object
  • geographicCoordinates object required
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • siteMainIsLegalAddress boolean required
  • additionalAddress object
  • bpnReference object required
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[] required
  • value string
  • type string
  • issuingBody string
  • states object[] required
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object required
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object required
  • geographicCoordinates object required
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object required
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • taxJurisdictionCode string
  • alternativeAddress object
  • geographicCoordinates object required
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • type string

    Possible values: [LegalEntity, Site, Address]

  • errors object[] required

    Errors that occurred during processing of this task

  • type string required

    Possible values: [Timeout, Unspecified]

    The type of error that occurred

  • description string required

    The free text, detailed description of the error

Responses

If the results could be processed

Loading...