This API is experimental and currently implements limited VOOT support suitable for the Conext platform.

Support for the VOOT API is deprecated as of Registry v4.0.0, and will no longer available from Registry v6.0.0.



View Groups per Identifier

Retrieve Groups attached to an Identifier.

Request Format

Method

GET

URL

/voot/groups/<identifier>[?count=<count>&startIndex=<start>&sortBy=<sortkey>]

Request Body



Response Format

HTTP Status

Response Body

Description

200 OK

VOOT Group Response

Groups returned

400 Bad Request


The request was not properly formed

401 Unauthorized


Authentication required

404 CO Person Unknown


The requested Identifier was found, but could not be mapped to a CO Person

404 Identifier Unknown


The requested Identifier was not found

500 Other Error


Unknown error

Notes

sortkey may be description, id, or title.


View Group per Identifier

Retrieve a single Group attached to an Identifier.

Request Format

Method

GET

URL

/voot/groups/<identifier>/<groupid>

Request Body



Response Format

HTTP Status

Response Body

Description

200 OK

VOOT Group Response

Groups returned

400 Bad Request


The request was not properly formed

401 Unauthorized


Authentication required

404 CO Person Unknown


The requested Identifier was found, but could not be mapped to a CO Person

404 Identifier Unknown


The requested Identifier was not found

500 Other Error


Unknown error



View People per Group

Retrieve People attached to a Group.

Request Format

Method

GET

URL

/voot/people/<identifier>/<cogroupid>[?count=<count>&startIndex=<start>]

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

VOOT Person Response

Groups returned

400 Bad Request


The request was not properly formed

401 Unauthorized


Authentication required

404 CO Person Unknown


The requested Identifier was found, but could not be mapped to a CO Person

404 Identifier Unknown


The requested Identifier was not found

500 Other Error


Unknown error



Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels