Catalogs

Create a new catalog

POST https://api.borlaug.network/identity/catalogs

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	BWS authorization token

Request Body

Name	Type	Description
name	string	The name of the catalog

200 Registry successfully created.

{
    "result": "success",
    "hash": "0xd3f16b32a9ce51d6ed2a6dfb43bcf0f69b78618b3a391fce5ddbc6462c7fb5e8",
    "block": "0x103eb49619c7f79a4e76292b8ceafc4e1aaad6b4531ccdfcbb5e26c74319d6df",
    "extrinsic": "0xd8f3653767461c653fcdeb1404b7ac49fe878e6dab2241bf211176d964e44662",
    "created": "2020-02-03T10:35:48.016896"
}

Example body:

{
	"name" : "Test Catalog"
}

List your catalogs

GET https://api.borlaug.network/identity/catalogs

Headers

Name	Type	Description
Authentication	string	Authentication token

200

{
    "catalogs": [
        {
            "catalog": "0xa5c2257dc9fc27dfc3faba29ee143b898d011d3145cdb80ecd9bd715c600d9b3",
            "created_by": "5EPProJ16yFLo5K29iC3QuPJ5sqS1Qm3Hoi3MG6vfxg8SWPt",
            "created": "2020-01-30T11:16:42.211349",
            "name": "Test Application",
            "block": "0x427c461a6f48e100dc0e5a86445c763a1b76d771016ab8d870170143c9337a17",
            "extrinsic": "0x4f4ad253a191d2d49adbd3d21e48f6f07ce87d2fe2eaada8f56200c09cff10c6"
        }
    ]
}

List all DIDs in a catalog

GET https://api.borlaug.network/identity/catalogs/:catalogid/dids

Path Parameters

Name	Type	Description
catalog_id	number	Catalog in question
page	number	For pagination
per_page	number	Number of DIDs per page

Headers

Name	Type	Description
Authorization	string	BWS authorization token

200

{
    "dids": [
        {
            "did": {
                "id": 1,
                "did": "0x37052298c931f77da860fdf165611187bb89f76a3f2ee20abbf538836822a2f5",
                "catalog": "0x73cc6c92ddc387e81e3ff890bc93bb6d857e0ad8bc2bf6d2a863a644b1b2eef8",
                "created_by": "5EZ7gNcZidoanKK45JK4YVQNDpEScbcCNbV4BU7fJWJdAFsu",
                "referent": null,
                "created": "2020-02-05T10:22:30.020284",
                "block": "0x20fdb4a3e9ad6c1b0f609884b45a8622f6499f636ab2446d059655f7d9bf5b9b",
                "extrinsic": "0x5c15820bc6822ad8f90847a643257a036454b296d1168a779fbc872b489f056e"
            },
            "properties": []
        }
    ],
    "total": 1
}

Update catalog name

PATCH https://api.borlaug.network/identity/catalogs/:catalogid

Update catalog name

Path Parameters

Name	Type	Description
catalogid	number	Catalog to be updated

Headers

Name	Type	Description
Authorization	string	BWS authorization token

200

Add or remove DIDs in a catalog

PATCH https://api.borlaug.network/identity/catalogs/:catalogid/dids

Add or re

Path Parameters

Name	Type	Description
catalogid	number	Catalog to be modified

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	BWS authorization token

200

Request Body

{
	"add": [
		{
			"did": "0x8cf2f6310cc95c7780cc2390ae579fd93320bea3ecae91b237e61812caa3a929",
			"short_name":"HDFC"
		}
	],
	{
	"remove":
		[
			"0x8cf2f6310cc95c7780cc2390ae579fd93320bea3ecae91b237e61812caa3a929"
		]
}
}

Delete catalog

DELETE https://api.borlaug.network/identity/catalogs/:catalogid

Removes the catalog and DIDs in the catalog. NOTE: The DIDs themselves are not deleted from DID registry.

Path Parameters

Name	Type	Description
catalogid	number	Catalog to be removed

Headers

Name	Type	Description
Authorization	string	BWS authorization token

200