/
Delete a Staff
Delete a Staff
- Zach Zhao (Unlicensed)
Owned by Zach Zhao (Unlicensed)
Last updated: Jun 01, 2013Version comment
A staff cannot be deleted if it is associated with a class, test or test result. (You may want to deactivate rather than delete a staff if there are data associated with the staff.)
Resource URI
/staffs/{id}
HTTPS DELETE
/staffs/{id}?timestamp={TimeStamp}&accesskey={AccessKey}&tag={Token}
Parameters for Request URL
The following parameters should be included in the request URL of the HTTPS DELETE call to delete a staff.
Parameter | Required? | Data Type | Description |
|---|---|---|---|
| id | Yes | INTEGER | the unique ID that identifies the staff in the LinkIt! database. |
| TimeStamp | Yes | DATETIME | the GMT time at which the call is generated. EXAMPLE: 5/1/2013+5:10:5+PM |
| AccessKey | Yes | STRING (128) | a unique key associated with the API user. EXAMPLE: 123456789-987654321 |
| Tag | Yes | STRING (128) | token generated for authorization and authentication. |
Response
The following fields are included in the response following an HTTPS DELETE call to delete a staff .
| Field Name | Data Type | Description | Example |
|---|---|---|---|
| Result | STRING (10) | indicates whether the staff is deleted successfully. | SUCCESS ERROR |
| Data | JSON/XML | returns "null" following an HTTPS DELETE call. | |
| Error | STRING (100) | provides explanation if result is ERROR."Null" is returned if result is SUCCESS. | Click here for a list of error messages. |
Example
Delete the staff (ID: 324024).
Navigation and Reference
, multiple selections available,