Get list upload status
|
1 |
GET /api/1/list/{jobid}/status |
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| Authorization: | Header | False | Required | String (Bearer {access token}) | Pass the authentication token that was granted when you authorized access. |
| jobid | Path | False | Required | String | The jobid of the list upload. |
Request
HTTP
Following is an example HTTP request:
|
1 2 3 4 |
GET /api/1/list/8167376/status HTTP/1.1 Host: restapi.actonsoftware.com Authorization: Bearer c377fca394e8810f43461f06f5ecbf7 Cache-Control: no-cache |
Response
A successful request results in an HTTP 200 response with a JSON object that contains information about the upload status.
An example JSON response for a Get List Upload Status request: “jobDetails” is an escaped string with the response where as “details” is human readable/pretty printed.
|
1 |
{"status":"success","jobDetails":"{"status":"ok","listId":"l-0017","appendCount":1,"updateCount":0,"failedCount":0,"rejectedCount":0}","details":{"status":"ok","listId":"l-0017","appendCount":1,"updateCount":0,"failedCount":0,"rejectedCount":0}} |
Code Examples
|
1 |
curl -X GET https://restapi.actonsoftware.com/api/1/list/15960012/status -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs" |
