/partner-api/inspection-associationsQuery inspection associations
Explore the query inspection associations endpoint, including request parameters and response details.
Parameters
1 parameterqstringoptionalJSON query criteria encoded with encodeURIComponent. The fields below describe the decoded JSON object.
q.where.typestring[]Filter by source inspection type.
q.where.brandIdnumber[]Filter by source inspection brand IDs.
q.where.inspectionUrlobjectMatch the source inspection URL.
q.where.associationStatusstringFilter by associated or unassociated; typically associated.
q.paginationobjectPagination: current page and pageSize; defaults are 1 and 20.
{
"where": {
"brandId": [
1
],
"associationStatus": "associated"
},
"pagination": {
"current": 1,
"pageSize": 10
}
}Encode this JSON with encodeURIComponent(JSON.stringify(q)) before sending it as the q parameter.
Responses
Successful responsesresponsepartnerInspectionAssociationResponseoptionaldatapartnerInspectionAssociationItem[]optionalsourceInspectionIdintegeroptionalsourceRecordIdstringoptionalsourceUrlstringnulloptionalrelationshipTypestringoptionalrelatedInspectionIdintegeroptionalrelatedRecordIdstringoptionalrelatedUrlstringnulloptionalrelatedAttackTypestringnulloptionalrelatedStatusstringnulloptionalrelatedBrandpartnerBrandNameoptionalRelated brand. Null when the related inspection has no brand.
brandIdintegeroptionaloriginalNamestringoptionalBrand name in its original language.
englishNamestringoptionalnotestringnulloptionalpaginationpaginationoptionaltotalintegeroptionalTotal number of records (unpaginated) based on the query criteria.
pageSizeintegeroptionalPage size. Default page size is applied if not specified. Maximum 100.
currentintegeroptionalCurrent page starting from 1.
