compliance API1.2.0

PagedComplianceViolationCollection

This type is used by the base response of the getListingViolations method.

Types that use PagedComplianceViolationCollection

Not used by any types

Call that uses PagedComplianceViolationCollection

Fields

Field
Type
Description
offset
The distance {number of records) from the first policy violation in the collection to the first policy violation in this result set. In the call request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 30 and limit is set to 10, the call retrieves policy violations 31 thru 40 from the resulting collection of policy violations.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

Default: 0 {zero)
href
The URI of the getListingViolations call request that produced the current page of the result set.
total
The total number of policy violations in the result set.

Note: If no policy violations are found, this field is returned with a value of 0.
next
The getListingViolations call URI to use to view the next page of the result set. For example, the following URI returns policy violations 41 thru 50 from the collection of policy violations:

path/listing_violation?limit=10&offset=40

This field is only returned if an additional page of listing violations exists.
prev
The getListingViolations call URI to use to view the previous page of the result set. For example, the following URI returns policy violations 21 thru 30 from the collection of policy violations:

path/listing_violation?limit=10&offset=20

Note: This feature employs a zero-based list, where the first policy violation in the list has an offset of 0.

This field is only returned if a previous page of listing violations exists.
limit
The maximum number of policy violations returned per page of the result set.

Note: If this is the last or only result set in the collection, it may contain fewer listing violations than the limit value. To determine the number of pages in the result set, divide this value into the value of total and round up to the next integer.

Default: 50
Max: 200
listingViolations
An array of listing violations that match the criteria in the call request, including pagination control {if set). As long as there is at least one violation for the specified compliance type, this container will be returned. If no listing violations are found for the seller, an HTTP status code of 204 No Content is returned, and there is no response body.