Agent Schema - DRAFT (0.1.0)

Download OpenAPI specification:Download

E-mail: info@dina-project.net License: Apache 2.0

Agent API Schema

Person

List persons

By passing in query string, user can get available persons authorised

query Parameters

filter[rsql]	string pass an optional search string for looking up the persons
sort	string optional sort order string, such as descending, denoted by "-"
page[offset]	integer <int32> number of records to skip when paging
page[limit]	integer <int32> [ 0 .. 50 ] maximum number of records to return when paging

Responses

Response samples

200

Content type

application/vnd.api+json

[{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "person",
"attributes": {"displayName": "test user",
"email": "test@canada.ca",
"createdBy": "test user",
"createdOn": "1985-04-12T23:20:50.52Z",
"givenNames": "Jane",
"familyNames": "Doe",
"webpage": "https://github.com/DINA-Web",
"remarks": "this is a mock remark",
"aliases": ["Jane Roe",
"Janie Doe"
]
},
"relationships": {"organizations": {"data": [{"type": "organization",
"id": "a600f9da-fcbe-4fef-9ae3-0f131ca05e0c"
}
]
},
"identifiers": {"data": [{"type": "identifier",
"id": "a600f9da-fcbe-4fef-9ae3-0f131ca05e0c"
}
]
}
}
}
}
]

Add a person

Request Body schema: application/vnd.api+json

Person to add

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "person",
"attributes": {"displayName": "test user",
"email": "test@canada.ca",
"givenNames": "Jane",
"familyNames": "Doe",
"webpage": "https://github.com/DINA-Web",
"remarks": "this is a mock remark",
"aliases": ["Jane Roe",
"Janie Doe"
]
},
"relationships": {"organizations": {"data": [{"type": "organization",
"id": "a600f9da-fcbe-4fef-9ae3-0f131ca05e0c"
}
]
},
"identifiers": {"data": [{"type": "identifier",
"id": "a600f9da-fcbe-4fef-9ae3-0f131ca05e0c"
}
]
}
}
}
}

Get a person

Return a single person

path Parameters

Id

required

string <uuid>

ID of person to return

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "person",
"attributes": {"displayName": "test user",
"email": "test@canada.ca",
"createdBy": "test user",
"createdOn": "1985-04-12T23:20:50.52Z",
"givenNames": "Jane",
"familyNames": "Doe",
"webpage": "https://github.com/DINA-Web",
"remarks": "this is a mock remark",
"aliases": ["Jane Roe",
"Janie Doe"
]
},
"relationships": {"organizations": {"data": [{"type": "organization",
"id": "a600f9da-fcbe-4fef-9ae3-0f131ca05e0c"
}
]
},
"identifiers": {"data": [{"type": "identifier",
"id": "a600f9da-fcbe-4fef-9ae3-0f131ca05e0c"
}
]
}
}
}
}

Update a person

path Parameters

Id

required

string <uuid>

person id to patch

Request Body schema: application/vnd.api+json

person to add

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "person",
"attributes": {"displayName": "test user",
"email": "test@canada.ca",
"givenNames": "Jane",
"familyNames": "Doe",
"webpage": "https://github.com/DINA-Web",
"remarks": "this is a mock remark",
"aliases": ["Jane Roe",
"Janie Doe"
]
},
"relationships": {"organizations": {"data": [{"type": "organization",
"id": "a600f9da-fcbe-4fef-9ae3-0f131ca05e0c"
}
]
},
"identifiers": {"data": [{"type": "identifier",
"id": "a600f9da-fcbe-4fef-9ae3-0f131ca05e0c"
}
]
}
}
}
}

Delete a person

path Parameters

Id

required

string <uuid>

person id to delete

Responses

Identifier

List identifiers

By passing in query string, user can get available identifiers authorised

query Parameters

filter[rsql]	string pass an optional search string for looking up the persons
sort	string optional sort order string, such as descending, denoted by "-"
page[offset]	integer <int32> number of records to skip when paging
page[limit]	integer <int32> [ 0 .. 50 ] maximum number of records to return when paging

Responses

Response samples

200

Content type

application/vnd.api+json

[{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "identifier",
"attributes": {"namespace": "wikidata",
"value": "http://www.wikidata.org/entity/Q51044",
"createdBy": "test user",
"createdOn": "1985-04-12T23:20:50.52Z"
}
}
}
]

Add an Identifier

Add a identifier

Request Body schema: application/vnd.api+json

Identifier to add

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "identifier",
"attributes": {"namespace": "wikidata",
"value": "http://www.wikidata.org/entity/Q51044"
}
}
}

Get an identifier

Return a single identifier

path Parameters

Id

required

string <uuid>

ID of the Identifier to return

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "identifier",
"attributes": {"namespace": "wikidata",
"value": "http://www.wikidata.org/entity/Q51044",
"createdBy": "test user",
"createdOn": "1985-04-12T23:20:50.52Z"
}
}
}

Update an identifier

Update a identifier

path Parameters

Id

required

string <uuid>

Identifier id to patch

Request Body schema: application/vnd.api+json

Identifier to add

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "identifier",
"attributes": {"namespace": "wikidata",
"value": "http://www.wikidata.org/entity/Q51044"
}
}
}

Delete an identifier

path Parameters

Id

required

string <uuid>

Identifier id to delete

Responses

Organization

List organizations

By passing in query string, user can get available Organizations authorised

query Parameters

filter[rsql]	string pass an optional search string for looking up the Organizations
sort	string optional sort order string, such as descending, denoted by "-"
page[offset]	integer <int32> number of records to skip when paging
page[limit]	integer <int32> [ 0 .. 50 ] maximum number of records to return when paging

Responses

Response samples

200

Content type

application/vnd.api+json

[{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "organization",
"attributes": {"names": [{"languageCode": "EN",
"name": "World Wide Fund for Nature"
},
{"languageCode": "FR",
"name": "Fonds mondial pour la nature"
}
],
"aliases": ["WWF",
"World Wide Fund for Nature"
],
"createdBy": "test user",
"createdOn": "1985-04-12T23:20:50.52Z"
}
}
}
]

Add an organization

Request Body schema: application/vnd.api+json

Organization to add

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"type": "organization",
"attributes": {"names": [{"languageCode": "EN",
"name": "World Wide Fund for Nature"
},
{"languageCode": "FR",
"name": "Fonds mondial pour la nature"
}
],
"aliases": ["WWF",
"World Wide Fund for Nature"
]
}
}
}

Get an organization

Return a single organization

path Parameters

Id

required

string <uuid>

ID of organization to return

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "organization",
"attributes": {"names": [{"languageCode": "EN",
"name": "World Wide Fund for Nature"
},
{"languageCode": "FR",
"name": "Fonds mondial pour la nature"
}
],
"aliases": ["WWF",
"World Wide Fund for Nature"
],
"createdBy": "test user",
"createdOn": "1985-04-12T23:20:50.52Z"
}
}
}

Update an organization

path Parameters

Id

required

string <uuid>

organization id to patch

Request Body schema: application/vnd.api+json

organization to add

required

object

Responses

Request samples

Payload

Content type

application/vnd.api+json

{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "organization",
"attributes": {"names": [{"languageCode": "EN",
"name": "World Wide Fund for Nature"
},
{"languageCode": "FR",
"name": "Fonds mondial pour la nature"
}
],
"aliases": ["WWF",
"World Wide Fund for Nature"
]
}
}
}

Delete an organization

path Parameters

Id

required

string <uuid>

organization id to delete