HomeGuidesAPI Reference
Guides

Sample Responses for Create Snapshot Requests

Response

ElementDescriptionType
codeThe response code can have following values:   success, failurestring
detailsDetails of the error if value of response code is failurestring
snapshotIdID of the snapshotstring
jobStatusIt is an indicator to confirm status of snapshot generation

The possible values of jobStatus are:
pending, processing, done, failed, expired		string

Sample Response 1

[ { "code": "success", "snapshotId": "10", "details": "", "jobStatus": "pending" }
]

Sample Response 2

[ { "code": "failure", "snapshotId": "", "details": "StartDate Validation Failed: Please try a startDate before date: 2019-03-01/endDate validation failed : Reports are available for endDate till date: 2019-03-01 /", "jobStatus": "" }
]

Sample Response 3

[ { "code": "success", "snapshotId": "11", "details": "", "jobStatus": "pending" }
]

Sample Response 4

[ { "code": "success", "snapshotId": "15", "details": "", "jobStatus": "pending" }
]

Sample Response 5

[ { "code": "success", "snapshotId": "16", "details": "", "jobStatus": "pending" }
]

Sample Response 6

[ { "code": "success", "snapshotId": "17", "details": "", "jobStatus": "pending" }
]

Sample Response 7

[ { "code": "success", "snapshotId": "18", "details": "", "jobStatus": "pending" }
]

Sample Response 8

[ { "code": "success", "snapshotId": "19", "details": "", "jobStatus": "pending" }
]

Sample Response 9

[ { "code": "success", "snapshotId": "20", "details": "", "jobStatus": "pending" }
]

Sample Response 10

[ { "code": "success", "snapshotId": "21", "details": "", "jobStatus": "pending" }
]

Updated 4 months ago