The AdHocAttribute API does not support XML format.

Add

Add a new AdHocAttribute.

Request Format

Method

POST

URL

/ad_hoc_attributes.<format>

Request Body

AdHocAttribute Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of AdHocAttribute

AdHocAttribute added

400 Bad Request


AdHocAttribute 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 Department, a CO Person Role, or an Org Identity must be specified to attach the Ad Hoc Attribute to

403 Person Does Not Exist


The specified CO Department, CO Person Role, or Org Identity does not exist

500 Other Error


Unknown error

Delete

Remove an AdHocAttribute.

Request Format

Method

DELETE

URL

/ad_hoc_attributes/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 Deleted


AdHocAttribute deleted

400 Invalid Fields


id not provided

401 Unauthorized


Authentication required

404 AdHocAttribute Unknown


id not found

500 Other Error


Unknown error

Edit

Edit an existing AdHocAttribute.

Request Format

Method

PUT

URL

/ad_hoc_attributes/<id>.<format>

Request Body

AdHocAttribute Request

Response Format

HTTP Status

Response Body

Description

200 OK


AdHocAttribute updated

400 Bad Request


AdHocAttribute 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 Department, a CO Person Role, or an Org Identity must be specified to attach the Ad Hoc Attribute to

403 Person Does Not Exist


The specified CO Department, CO Person Role, or Org Identity does not exist

404 AdHocAttribute Unknown


id not found

500 Other Error


Unknown error

View (all)

Retrieve all existing AdHocAttributes.

Request Format

Method

GET

URL

/ad_hoc_attributes.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

AdHocAttribute Response

AdHocAttributes returned

401 Unauthorized


Authentication required

500 Other Error


Unknown error

View (per person)

Retrieve AdHocAttributes attached to a CO Department, CO Person Role, or Org Identity.

Request Format

Method

GET

URL

/ad_hoc_attributes.<format>?[codeptid|copersonroleid|organizationid|orgidentityid]=<id>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

AdHocAttribute Response

AdHocAttribute returned

204 CO Department Has No AdHocAttribute

The requested CO Department was found, but has no ad hoc attributes attached

204 CO Person Role Has No AdHocAttribute


The requested CO Person Role was found, but has no ad hoc attributes attached

204 Organization Has No AdHocAttribute


The requested Organization was found, but has no ad hoc attributes attached

204 Org Identity Has No AdHocAttribute


The requested Org Identity was found, but has no ad hoc attributes attached

401 Unauthorized


Authentication required

404 CO Department Unknown


id not found for CO Department

404 CO Person Role Unknown


id not found for CO Person Role

404 Organization Unknown


id not found for Organization

404 Org Identity Unknown


id not found for Org Identity

500 Other Error


Unknown error

View (one)

Retrieve an existing AdHocAttribute.

Request Format

Method

GET

URL

/ad_hoc_attributes/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

AdHocAttribute Response

AdHocAttribute returned

401 Unauthorized


Authentication required

404 AdHocAttribute Unknown


id 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