Add

Add a new HistoryRecord.

Request Format

Method

POST

URL

/history_records.<format>

Request Body

HistoryRecord Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of HistoryRecord

HistoryRecord added

400 Bad Request

 

HistoryRecord Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized

 

Authentication required

403 No Person Specified

 

A CO Person or an Org Identity must be specified to attach the HistoryRecord to

403 Person Does Not Exist

 

The specified CO Person or Org Identity does not exist

500 Other Error

 

Unknown error

View (all)

Retrieve all existing HistoryRecords.

Request Format

Method

GET

URL

/history_records.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

HistoryRecord Response

HistoryRecords returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error

View (per person)

Retrieve HistoryRecords attached to a CO Person or Org Identity.

Request Format

Method

GET

URL

/history_records.<format>?[copersonid|orgidentityid]=<id>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

HistoryRecord Response

HistoryRecord returned

401 Unauthorized

 

Authentication required

404 CO Person Unknown

 

id not found for CO Person

404 Org Identity Unknown

 

id not found for Org Identity

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