Bulk

Delete Diamond Assets

post

https://api.<id>.tracr.networkhttps://api.<id>.uat.tracr.network

/bulk/diamond-asset/delete

Body

application/json

A request to delete one or more diamond assets.

Responses

200

The request was processed successfully. The result of each deletion is determined by looking at individual deletion status for each diamond asset.

application/json

A response from the /bulk/diamond-asset/delete endpoint containing the status of each deleted diamond.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

409

The request was unable to be processed due to one of the diamond assets in the request (or the asset's related diamond) being updated by another process.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/bulk/diamond-asset/delete

HTTPcURLJavaScriptPython

POST /bulk/diamond-asset/delete HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "assets": [
    {
      "diamond_asset_id": "text"
    }
  ]
}

{
  "results": [
    {
      "diamond_asset_id": "text",
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "errors": [
        {
          "error_code": "diamond_asset_not_found",
          "message": "text"
        }
      ],
      "status": "success"
    }
  ]
}

Bulk Mark As Archived

post

https://api.<id>.tracr.networkhttps://api.<id>.uat.tracr.network

/bulk/diamonds/archive

Mark diamonds as archived, if they're available to be archived.

Body

application/json

A list of diamonds to mark as archived.

Responses

200

Successful Response

application/json

Aggregated results of marking diamonds as archived.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/bulk/diamonds/archive

HTTPcURLJavaScriptPython

POST /bulk/diamonds/archive HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "diamonds": [
    {
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums"
    }
  ]
}

{
  "results": [
    {
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "status": "success"
    }
  ]
}

Bulk Delete Diamonds

post

https://api.<id>.tracr.networkhttps://api.<id>.uat.tracr.network

/bulk/diamonds/delete

Permanently delete diamonds from a participant's inventory.

Body

application/json

dry_runbooleanOptional

If true, no diamonds will be deleted. The API will return the response as if it did.

Default: false

Responses

200

Successful Response

application/json

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/bulk/diamonds/delete

HTTPcURLJavaScriptPython

POST /bulk/diamonds/delete HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "diamonds": [
    {
      "delete_descendants": true,
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums"
    }
  ],
  "dry_run": false
}

{
  "results": [
    {
      "descendants": [
        {
          "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
          "participant_id": "text"
        }
      ],
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "error": "text",
      "participant_id": "text",
      "status": "descendants_in_active_shipment"
    }
  ]
}

Bulk Unarchive

post

https://api.<id>.tracr.networkhttps://api.<id>.uat.tracr.network

/bulk/diamonds/unarchive

Un-archive diamonds, if they're available to be un-archived.

Body

application/json

A list of diamonds to un-archive.

Responses

200

Successful Response

application/json

Aggregated results of un-archiving diamonds.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Unprocessable Entity, request JSON body is not as per specification

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/bulk/diamonds/unarchive

HTTPcURLJavaScriptPython

POST /bulk/diamonds/unarchive HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "diamonds": [
    {
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums"
    }
  ]
}

{
  "results": [
    {
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "status": "success"
    }
  ]
}

Unlock Diamonds

post

https://api.<id>.tracr.networkhttps://api.<id>.uat.tracr.network

/bulk/diamonds/unlock

Unlock the diamonds in the request body, if they're available to unlock.

Body

application/json

Represents a request to unlock one or more locked diamonds.

Responses

200

Successful Response

application/json

Represents the response to an UnlockRequest.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

403

Forbidden: The application does not have sufficient permissions for this operation.

422

Returned if the request body is malformed or does not contain any diamonds

500

Internal Server Error. If this error persists please contact the Platform Admin team.

post/bulk/diamonds/unlock

HTTPcURLJavaScriptPython

POST /bulk/diamonds/unlock HTTP/1.1
Host: api.<id>.tracr.network
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "diamonds": [
    {
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums"
    }
  ]
}

{
  "diamonds": [
    {
      "diamond_id": "e1mv3nn4n10kd1lw6mde6sums",
      "status": "diamond_does_not_exist"
    }
  ]
}