Returns a page with a list of completed scans.

Request
Security:
st_portal_auth
(read:scans)
query Parameters
size
integer [ 1 .. 100 ]
Default: 20

The numbers of items to return.

page
integer >= 0
Default: 0

Specifies to return the Nth page of size ${size}. First page is 0.

sort-by
string
Default: "id"

The field to sort results by. This affects which items are returned on a particular page. Typically, the primary key of the resource is used by default

sort-dir
string
Default: "asc"

Sort order:

  • asc - Ascending, from A to Z, 1 to 9
  • desc - Descending, from Z to A, 1 to 9
Enum: "asc" "desc"
sponsorId
integer <int64>

id of the sponsor which should be used to filter list

Example: sponsorId=1
required
object (SiteScanStatusEnumWrapper)
object (ViolationTypeEnumWrapper)
object (SiteScanIdWrapper)
merchantName
string (MerchantName) [ 1 .. 255 ] characters

Name of merchant

Example: merchantName=Preferred Merchant
mid
string (MID) <= 255 characters

Merchant ID (MID) of merchant assigned by sponsor

Example: mid=12345678
dba
string (DBA) <= 255 characters

DBA of merchant

Example: dba=Preferred Merchant Store
url
string <url> (URL) [ 7 .. 255 ] characters ^(https?):\/\/[-a-zA-Z0-9+&@#\/%?=~_|!:,.;]*[...
Example: url=https://www.vikingcloud.com/
start-date
string <date>

The start date for the report. May be used together with end_date.

end-date
string <date>

The end date for the report. May be used together with start_date.

Responses
200

successful operation

400

Bad Request. The request parameters (or body) were malformed or invalid. Fix the issues with the request and try again.

401

Unauthorized request. Make sure token was included and is valid and try again.

403

Forbidden. You are not permitted to access the requested resource.

404

Not Found. The specified resource (or resource referred to by id) was not found

405

Method Not Allowed. The API was accessed with the wrong method

429

Too Many Requests. The API is rate-limited. Wait and try your request again.

500

Internal Server Error. An unexpected error has occurred. This may be due to a transient error. Retry the request and if the issue persists, please contact support.

503

Service Unavailable. The service is temporarily unavailable. Try your request later.

get/wrm/v1/scans/search
Request samples
curl -i -X GET \
  'https://api.vikingcloud.com/wrm/v1/scans/search?size=20&page=0&sort-by=id&sort-dir=asc&sponsorId=0&status=APPEALED&violationType=CBV&scanId=2&merchantName=Preferred%20Merchant&mid=12345678&dba=Preferred%20Merchant%20Store&url=https%3A%2F%2Fwww.vikingcloud.com%2F&start-date=2019-08-24&end-date=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "totalItems": 1000,
  • "pageSize": 20,
  • "pageNumber": 2,
  • "sortField": "id",
  • "sortDescending": false,
  • "pageItems": [
    ]
}