List Non-Employee Requests
GET {{baseUrl}}/non-employee-requests
This gets a list of non-employee requests. There are two contextual uses for the requested-for path parameter:
1. The user has the role context of idn:nesr:read, in which case he or
she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id.
2. The current user is an account manager, in which case me
should be
provided as the requested-for value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | Max number of results to return. | |
| See V3 API Standard Collection Parameters for more information. | |||
offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. | |
| See V3 API Standard Collection Parameters for more information. | |||
count | boolean | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. |
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information. |
| requested-for | string | | (Required) The identity for whom the request was made. me indicates the current user. |
| sorters | string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate |
| filters | string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
sourceId: eq |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"a0303682-5e4a-44f7-bdc2-6ce6112549c1","sourceId":"2c91808568c529c60168cca6f90c1313","name":"Retail","description":"Source description","accountName":"william.smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","nonEmployeeSource":{"id":"a0303682-5e4a-44f7-bdc2-6ce6112549c1","sourceId":"2c91808568c529c60168cca6f90c1313","name":"Retail","description":"Source description"},"data":{"description":"Auditing"},"approvalItems":[{"id":"2c1e388b-1e55-4b0a-ab5c-897f1204159c","approver":{"type":"IDENTITY","id":"5168015d32f890ca15812c9180835d2e"},"accountName":"test.account","approvalStatus":"APPROVED","approvalOrder":1,"comment":"I approve","modified":"2019-08-23T18:52:59.162Z","created":"2019-08-23T18:40:35.772Z"},{"id":"2c1e388b-1e55-4b0a-ab5c-897f1204159c","approver":{"type":"IDENTITY","id":"5168015d32f890ca15812c9180835d2e"},"accountName":"test.account","approvalStatus":"APPROVED","approvalOrder":1,"comment":"I approve","modified":"2019-08-23T18:52:59.162Z","created":"2019-08-23T18:40:35.772Z"}],"approvalStatus":"APPROVED","comment":"approved","completionDate":"2020-03-24T11:11:41.139-05:00","startDate":"2020-03-24T00:00:00-05:00","endDate":"2021-03-25T00:00:00-05:00","modified":"2020-03-24T11:11:41.139-05:00","created":"2020-03-24T11:11:41.139-05:00"},{"id":"a0303682-5e4a-44f7-bdc2-6ce6112549c1","sourceId":"2c91808568c529c60168cca6f90c1313","name":"Retail","description":"Source description","accountName":"william.smith","firstName":"William","lastName":"Smith","email":"william.smith@example.com","phone":"5555555555","manager":"jane.doe","nonEmployeeSource":{"id":"a0303682-5e4a-44f7-bdc2-6ce6112549c1","sourceId":"2c91808568c529c60168cca6f90c1313","name":"Retail","description":"Source description"},"data":{"description":"Auditing"},"approvalItems":[{"id":"2c1e388b-1e55-4b0a-ab5c-897f1204159c","approver":{"type":"IDENTITY","id":"5168015d32f890ca15812c9180835d2e"},"accountName":"test.account","approvalStatus":"APPROVED","approvalOrder":1,"comment":"I approve","modified":"2019-08-23T18:52:59.162Z","created":"2019-08-23T18:40:35.772Z"},{"id":"2c1e388b-1e55-4b0a-ab5c-897f1204159c","approver":{"type":"IDENTITY","id":"5168015d32f890ca15812c9180835d2e"},"accountName":"test.account","approvalStatus":"APPROVED","approvalOrder":1,"comment":"I approve","modified":"2019-08-23T18:52:59.162Z","created":"2019-08-23T18:40:35.772Z"}],"approvalStatus":"APPROVED","comment":"approved","completionDate":"2020-03-24T11:11:41.139-05:00","startDate":"2020-03-24T00:00:00-05:00","endDate":"2021-03-25T00:00:00-05:00","modified":"2020-03-24T11:11:41.139-05:00","created":"2020-03-24T11:11:41.139-05:00"}]