מחוברים עכשיו  

/v1/infractions/

Private user-infraction reporting, staff adjudication and bounty administration.
GET

/v1/infractions/get_bounty_estimate

#
Estimate the maximum USD bounty for a signed-in reporter using the current type, reported user's penalty permission and reporter's bounty rate. Assumes a full contribution share; staff decides the actual outcome and may award no bounty. Does not create a report or financial entry.

פרמטרים

שםסוגחובהברירת מחדלתיאור
typeID int כן — Active infraction type.
userAlias string כן — Reported user's alias. Self-reporting is not allowed.
incidentDate string לא "" Incident date in YYYY-MM-DD format; empty uses today for the estimate until a date is selected.
subjectTransactionSource string לא "" Required for transaction-based types: transaction or custom_article.
subjectTransactionID int לא 0 Required canonical transaction ID for transaction-based types.
דוגמת בקשה (cURL)
curl --get \
  'https://he.appointmenttrader.com/v1/infractions/get_bounty_estimate' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'typeID={{typeID}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'incidentDate={{incidentDate}}' \
  --data-urlencode 'subjectTransactionSource={{subjectTransactionSource}}' \
  --data-urlencode 'subjectTransactionID={{subjectTransactionID}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
שדות התגובה
שדהסוגחובהתיאור
$infractions_get_bounty_estimate_Response כן
$.oneOf[0] כן
$.oneOf[0].allOf[0]object כן
$.oneOf[0].allOf[0].RequestUserAliasstring כן
$.oneOf[0].allOf[0].RequestPathstring | null כן
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" כן
$.oneOf[0].allOf[0].ResponseCodeinteger כן
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring לא
$.oneOf[0].allOf[1]object כן
$.oneOf[0].allOf[1].Payloadobject כן
$.oneOf[0].allOf[1].Payload.amountCentsinteger כן
$.oneOf[0].allOf[1].Payload.currency = "USD" כן
$.oneOf[0].allOf[1].Payload.formattedAmountstring כן
$.oneOf[1]object כן
$.oneOf[1].RequestUserAliasstring כן
$.oneOf[1].RequestPathstring | null כן
$.oneOf[1].RequestStatus = "Failed" כן
$.oneOf[1].ResponseCodeinteger כן
$.oneOf[1].ResponseMessageAPIResponseMessage כן
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[1].ResponseMessage.oneOf[1]array כן
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[1].ResponseMessage.oneOf[2]object כן
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[1].RequestImpersonatedByUserAliasstring לא
דוגמת תגובה
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/infractions/get_bounty_estimate",
    "RequestUserAlias": "example-user",
    "Payload": {
        "amountCents": 0,
        "currency": "USD",
        "formattedAmount": "synthetic-example"
    }
}
תיעוד נקודת קצה קריא למכונה
GET

/v1/infractions/get_my_reports

#
Get only reports submitted by the acting user, including when the caller is staff. Reports against the caller are excluded. Merged reports retain their private chat and use the current case status and classification.

פרמטרים

שםסוגחובהברירת מחדלתיאור
start int לא 0 Non-negative offset; negative values use zero.
דוגמת בקשה (cURL)
curl --get \
  'https://he.appointmenttrader.com/v1/infractions/get_my_reports' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'start={{start}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
שדות התגובה
שדהסוגחובהתיאור
$infractions_get_my_reports_Response כן
$.oneOf[0] כן
$.oneOf[0].allOf[0]object כן
$.oneOf[0].allOf[0].RequestUserAliasstring כן
$.oneOf[0].allOf[0].RequestPathstring | null כן
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" כן
$.oneOf[0].allOf[0].ResponseCodeinteger כן
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring לא
$.oneOf[0].allOf[1]object כן
$.oneOf[0].allOf[1].Payloadobject כן
$.oneOf[0].allOf[1].Payload.reportsarray כן
$.oneOf[0].allOf[1].Payload.reports[]object לא
$.oneOf[0].allOf[1].Payload.reports[].reportIDinteger כן
$.oneOf[0].allOf[1].Payload.reports[].caseIDinteger כן
$.oneOf[0].allOf[1].Payload.reports[].reportedUserIDinteger כן
$.oneOf[0].allOf[1].Payload.reports[].typeNamestring כן
$.oneOf[0].allOf[1].Payload.reports[].createdDatestring כן
$.oneOf[0].allOf[1].Payload.reports[].statusstring ["Open","Confirmed","Warning","Rejected","Merged"] כן
$.oneOf[0].allOf[1].Payload.reports[].chatIDinteger כן
$.oneOf[0].allOf[1].Payload.startinteger כן
$.oneOf[0].allOf[1].Payload.hasMoreboolean כן
$.oneOf[0].allOf[1].Payload.nextStart כן
$.oneOf[0].allOf[1].Payload.nextStart.anyOf[0]integer כן
$.oneOf[0].allOf[1].Payload.nextStart.anyOf[1]null כן
$.oneOf[1]object כן
$.oneOf[1].RequestUserAliasstring כן
$.oneOf[1].RequestPathstring | null כן
$.oneOf[1].RequestStatus = "Failed" כן
$.oneOf[1].ResponseCodeinteger כן
$.oneOf[1].ResponseMessageAPIResponseMessage כן
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[1].ResponseMessage.oneOf[1]array כן
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[1].ResponseMessage.oneOf[2]object כן
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[1].RequestImpersonatedByUserAliasstring לא
דוגמת תגובה
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/infractions/get_my_reports",
    "RequestUserAlias": "example-user",
    "Payload": {
        "reports": [],
        "start": 0,
        "hasMore": false,
        "nextStart": 0
    }
}
תיעוד נקודת קצה קריא למכונה
GET

/v1/infractions/get_options

#
Get reportable types or staff configuration, numeric permissions and audit history.

פרמטרים

שםסוגחובהברירת מחדלתיאור
admin bool לא false Include inactive types and administration data; requires RefundAppointments.
דוגמת בקשה (cURL)
curl --get \
  'https://he.appointmenttrader.com/v1/infractions/get_options' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'admin={{admin}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
שדות התגובה
שדהסוגחובהתיאור
$infractions_get_options_Response כן
$.oneOf[0] כן
$.oneOf[0].allOf[0]object כן
$.oneOf[0].allOf[0].RequestUserAliasstring כן
$.oneOf[0].allOf[0].RequestPathstring | null כן
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" כן
$.oneOf[0].allOf[0].ResponseCodeinteger כן
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring לא
$.oneOf[0].allOf[1]object כן
$.oneOf[0].allOf[1].Payloadobject כן
$.oneOf[0].allOf[1].Payload.typesarray כן
$.oneOf[0].allOf[1].Payload.types[]object לא
$.oneOf[0].allOf[1].Payload.types[].IDDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.types[].ID.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.types[].ID.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.types[].Slugstring כן
$.oneOf[0].allOf[1].Payload.types[].Statusstring ["Draft","Active","Retired"] כן
$.oneOf[0].allOf[1].Payload.types[].SortOrderDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.types[].SortOrder.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.types[].SortOrder.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.types[].CurrentVersionID כן
$.oneOf[0].allOf[1].Payload.types[].CurrentVersionID.anyOf[0]DatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.types[].CurrentVersionID.anyOf[0].oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.types[].CurrentVersionID.anyOf[0].oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.types[].CurrentVersionID.anyOf[1]null כן
$.oneOf[0].allOf[1].Payload.types[].CreatedDatestring כן
$.oneOf[0].allOf[1].Payload.types[].VersionNumberDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.types[].VersionNumber.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.types[].VersionNumber.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.types[].configobject כן
$.oneOf[0].allOf[1].Payload.types[].config.namestring כן
$.oneOf[0].allOf[1].Payload.types[].config.descriptionstring כן
$.oneOf[0].allOf[1].Payload.types[].config.evidenceGuidancestring כן
$.oneOf[0].allOf[1].Payload.types[].config.subjectstring ["seller","transaction","listing"] כן
$.oneOf[0].allOf[1].Payload.types[].config.referenceRequired כן
$.oneOf[0].allOf[1].Payload.types[].config.referenceRequired.oneOf[0]boolean כן
$.oneOf[0].allOf[1].Payload.types[].config.referenceRequired.oneOf[1]integer [0,1] כן
$.oneOf[0].allOf[1].Payload.types[].config.penaltyModestring ["warning","fixed","annual_sales","transaction_amount"] כן
$.oneOf[0].allOf[1].Payload.types[].config.penaltyPermissionstring כן
$.oneOf[0].allOf[1].Payload.types[].config.bountyEnabled כן
$.oneOf[0].allOf[1].Payload.types[].config.bountyEnabled.oneOf[0]boolean כן
$.oneOf[0].allOf[1].Payload.types[].config.bountyEnabled.oneOf[1]integer [0,1] כן
$.oneOf[0].allOf[1].Payload.types[].config.bountyBasisPointsinteger כן
$.oneOf[0].allOf[1].Payload.types[].config.buyerPosingAllowed כן
$.oneOf[0].allOf[1].Payload.types[].config.buyerPosingAllowed.oneOf[0]boolean כן
$.oneOf[0].allOf[1].Payload.types[].config.buyerPosingAllowed.oneOf[1]integer [0,1] כן
$.oneOf[0].allOf[1].Payload.types[].config.translations כן
$.oneOf[0].allOf[1].Payload.types[].config.translations.anyOf[0]object כן
$.oneOf[0].allOf[1].Payload.types[].config.translations.anyOf[0].*object לא
$.oneOf[0].allOf[1].Payload.types[].config.translations.anyOf[0].*.namestring כן
$.oneOf[0].allOf[1].Payload.types[].config.translations.anyOf[0].*.descriptionstring כן
$.oneOf[0].allOf[1].Payload.types[].config.translations.anyOf[0].*.evidenceGuidancestring כן
$.oneOf[0].allOf[1].Payload.types[].config.translations.anyOf[1] = [] כן
$.oneOf[0].allOf[1].Payload.types[].config.seedKeystring לא
$.oneOf[0].allOf[1].Payload.types[].config.penaltyMultiplier = 3 לא
$.oneOf[0].allOf[1].Payload.types[].defaultPenaltyValue כן
$.oneOf[0].allOf[1].Payload.types[].defaultPenaltyValue.anyOf[0]DatabaseNumber כןNumeric value; MySQL reads can serialize numbers as numeric strings.
$.oneOf[0].allOf[1].Payload.types[].defaultPenaltyValue.anyOf[0].oneOf[0]number כן
$.oneOf[0].allOf[1].Payload.types[].defaultPenaltyValue.anyOf[0].oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.types[].defaultPenaltyValue.anyOf[1]null כן
$.oneOf[0].allOf[1].Payload.types[].reporterBountyBasisPointsinteger כן
$.oneOf[0].allOf[1].Payload.types[].rawConfigobject לא
$.oneOf[0].allOf[1].Payload.types[].rawConfig.namestring כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.descriptionstring כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.evidenceGuidancestring כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.subjectstring ["seller","transaction","listing"] כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.referenceRequired כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.referenceRequired.oneOf[0]boolean כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.referenceRequired.oneOf[1]integer [0,1] כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.penaltyModestring ["warning","fixed","annual_sales","transaction_amount"] כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.penaltyPermissionstring כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.bountyEnabled כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.bountyEnabled.oneOf[0]boolean כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.bountyEnabled.oneOf[1]integer [0,1] כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.bountyBasisPointsinteger כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.buyerPosingAllowed כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.buyerPosingAllowed.oneOf[0]boolean כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.buyerPosingAllowed.oneOf[1]integer [0,1] כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.translations כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.translations.anyOf[0]object כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.translations.anyOf[0].*object לא
$.oneOf[0].allOf[1].Payload.types[].rawConfig.translations.anyOf[0].*.namestring כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.translations.anyOf[0].*.descriptionstring כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.translations.anyOf[0].*.evidenceGuidancestring כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.translations.anyOf[1] = [] כן
$.oneOf[0].allOf[1].Payload.types[].rawConfig.seedKeystring לא
$.oneOf[0].allOf[1].Payload.types[].rawConfig.penaltyMultiplier = 3 לא
$.oneOf[0].allOf[1].Payload.permissionsarray כן
$.oneOf[0].allOf[1].Payload.permissions[]object לא
$.oneOf[0].allOf[1].Payload.permissions[].Namestring כן
$.oneOf[0].allOf[1].Payload.permissions[].Descriptionstring כן
$.oneOf[0].allOf[1].Payload.permissions[].DefaultSettingPayloadstring כן
$.oneOf[0].allOf[1].Payload.overridesarray כן
$.oneOf[0].allOf[1].Payload.overrides[]object לא
$.oneOf[0].allOf[1].Payload.overrides[].IDDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.overrides[].ID.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.overrides[].ID.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.overrides[].UserIDDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.overrides[].UserID.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.overrides[].UserID.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.overrides[].TypeIDDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.overrides[].TypeID.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.overrides[].TypeID.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.overrides[].BountyBasisPointsDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.overrides[].BountyBasisPoints.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.overrides[].BountyBasisPoints.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.overrides[].UpdatedByUserIDDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.overrides[].UpdatedByUserID.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.overrides[].UpdatedByUserID.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.overrides[].LastUpdateDatestring כן
$.oneOf[0].allOf[1].Payload.auditarray כן
$.oneOf[0].allOf[1].Payload.audit[]object לא
$.oneOf[0].allOf[1].Payload.audit[].IDDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.audit[].ID.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.audit[].ID.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.audit[].CaseID = null כן
$.oneOf[0].allOf[1].Payload.audit[].TypeID כן
$.oneOf[0].allOf[1].Payload.audit[].TypeID.anyOf[0]DatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.audit[].TypeID.anyOf[0].oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.audit[].TypeID.anyOf[0].oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.audit[].TypeID.anyOf[1]null כן
$.oneOf[0].allOf[1].Payload.audit[].ActorUserIDDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.audit[].ActorUserID.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.audit[].ActorUserID.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.audit[].EventNamestring כן
$.oneOf[0].allOf[1].Payload.audit[].Payloadstring (application/json) כן
$.oneOf[0].allOf[1].Payload.audit[].Payload (JSON מפוענח) כן
$.oneOf[0].allOf[1].Payload.audit[].Payload.oneOf[0]object כן
$.oneOf[0].allOf[1].Payload.audit[].Payload.oneOf[0].versionIDinteger כן
$.oneOf[0].allOf[1].Payload.audit[].Payload.oneOf[0].statusstring ["Draft","Active","Retired"] כן
$.oneOf[0].allOf[1].Payload.audit[].Payload.oneOf[0].sortOrderinteger כן
$.oneOf[0].allOf[1].Payload.audit[].Payload.oneOf[1]object כן
$.oneOf[0].allOf[1].Payload.audit[].Payload.oneOf[1].hunterIDinteger כן
$.oneOf[0].allOf[1].Payload.audit[].Payload.oneOf[1].basisPoints כן
$.oneOf[0].allOf[1].Payload.audit[].Payload.oneOf[1].basisPoints.anyOf[0]integer כן
$.oneOf[0].allOf[1].Payload.audit[].Payload.oneOf[1].basisPoints.anyOf[1]null כן
$.oneOf[0].allOf[1].Payload.audit[].CreatedDatestring כן
$.oneOf[1]object כן
$.oneOf[1].RequestUserAliasstring כן
$.oneOf[1].RequestPathstring | null כן
$.oneOf[1].RequestStatus = "Failed" כן
$.oneOf[1].ResponseCodeinteger כן
$.oneOf[1].ResponseMessageAPIResponseMessage כן
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[1].ResponseMessage.oneOf[1]array כן
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[1].ResponseMessage.oneOf[2]object כן
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[1].RequestImpersonatedByUserAliasstring לא
דוגמת תגובה
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/infractions/get_options",
    "RequestUserAlias": "example-user",
    "Payload": {
        "types": [],
        "permissions": [],
        "overrides": [],
        "audit": []
    }
}
תיעוד נקודת קצה קריא למכונה
GET

/v1/infractions/get_report_context

#
Resolve report context from a listing, participant-owned transaction, accessible chat or reported user. Chat targets use structured context or the sole other participant; ambiguous groups leave the user unselected.

פרמטרים

שםסוגחובהברירת מחדלתיאור
listingID int לא 0 Listing identifier, or zero.
transactionID int לא 0 Transaction identifier, or zero.
chatID int לא 0 Source chat accessible to the reporter, or zero.
userID int לא 0 Reported user to preselect, or zero.
subjectTransactionSource string לא "" Optional exact transaction source, transaction or custom_article; does not alter the reported user.
subjectTransactionID int לא 0 Canonical transaction ID paired with its source.
דוגמת בקשה (cURL)
curl --get \
  'https://he.appointmenttrader.com/v1/infractions/get_report_context' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listingID={{listingID}}' \
  --data-urlencode 'transactionID={{transactionID}}' \
  --data-urlencode 'chatID={{chatID}}' \
  --data-urlencode 'userID={{userID}}' \
  --data-urlencode 'subjectTransactionSource={{subjectTransactionSource}}' \
  --data-urlencode 'subjectTransactionID={{subjectTransactionID}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
שדות התגובה
שדהסוגחובהתיאור
$infractions_get_report_context_Response כן
$.oneOf[0] כן
$.oneOf[0].allOf[0]object כן
$.oneOf[0].allOf[0].RequestUserAliasstring כן
$.oneOf[0].allOf[0].RequestPathstring | null כן
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" כן
$.oneOf[0].allOf[0].ResponseCodeinteger כן
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring לא
$.oneOf[0].allOf[1]object כן
$.oneOf[0].allOf[1].PayloadInfractionReportContext כן
$.oneOf[0].allOf[1].Payload.oneOf[0]object כן
$.oneOf[0].allOf[1].Payload.oneOf[0].chatIDinteger לא
$.oneOf[0].allOf[1].Payload.oneOf[0].chatNamestring לא
$.oneOf[0].allOf[1].Payload.oneOf[0].listingID לא
$.oneOf[0].allOf[1].Payload.oneOf[0].listingID.anyOf[0]DatabaseInteger לאInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.oneOf[0].listingID.anyOf[0].oneOf[0]integer לא
$.oneOf[0].allOf[1].Payload.oneOf[0].listingID.anyOf[0].oneOf[1]string לא
$.oneOf[0].allOf[1].Payload.oneOf[0].listingID.anyOf[1]null לא
$.oneOf[0].allOf[1].Payload.oneOf[0].transactionIDDatabaseInteger לאInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.oneOf[0].transactionID.oneOf[0]integer לא
$.oneOf[0].allOf[1].Payload.oneOf[0].transactionID.oneOf[1]string לא
$.oneOf[0].allOf[1].Payload.oneOf[0].sellerIDDatabaseInteger לאInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.oneOf[0].sellerID.oneOf[0]integer לא
$.oneOf[0].allOf[1].Payload.oneOf[0].sellerID.oneOf[1]string לא
$.oneOf[0].allOf[1].Payload.oneOf[0].sellerAliasstring לא
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction לא
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction.anyOf[0]object לא
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction.anyOf[0].sourcestring ["transaction","custom_article"] כן
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction.anyOf[0].idinteger כן
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction.anyOf[0].amountCentsinteger כן
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction.anyOf[0].datestring כן
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction.anyOf[0].labelstring כן
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction.anyOf[0].statusstring ["PENDING","COMPLETED","RECORDED"] כן
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction.anyOf[0].formattedAmountstring כן
$.oneOf[0].allOf[1].Payload.oneOf[0].subjectTransaction.anyOf[1]null לא
$.oneOf[0].allOf[1].Payload.oneOf[1] = [] כן
$.oneOf[1]object כן
$.oneOf[1].RequestUserAliasstring כן
$.oneOf[1].RequestPathstring | null כן
$.oneOf[1].RequestStatus = "Failed" כן
$.oneOf[1].ResponseCodeinteger כן
$.oneOf[1].ResponseMessageAPIResponseMessage כן
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[1].ResponseMessage.oneOf[1]array כן
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[1].ResponseMessage.oneOf[2]object כן
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[1].RequestImpersonatedByUserAliasstring לא
דוגמת תגובה
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/infractions/get_report_context",
    "RequestUserAlias": "example-user",
    "Payload": []
}
תיעוד נקודת קצה קריא למכונה
GET

/v1/infractions/get_report_transactions

#
Resolve an exact transaction reference for a signed-in reporter, regardless of ownership. Staff verifies the connection to the reported user. Only pending/completed marketplace transactions and non-deleted recorded custom articles with valid amounts are returned.

פרמטרים

שםסוגחובהברירת מחדלתיאור
referenceType string כן — post_link, bid, appointment, transaction, or custom_article.
referenceID int לא 0 Exact identifier in the selected namespace; positive except for post_link, which uses postLink.
postLink string לא "" AppointmentTrader post URL or root-relative post path, required for post_link. Resolves the viewable post's stored bid association without fetching the URL. Supports /posts/{id} and the v2 newsfeed postId route.
דוגמת בקשה (cURL)
curl --get \
  'https://he.appointmenttrader.com/v1/infractions/get_report_transactions' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'referenceType={{referenceType}}' \
  --data-urlencode 'referenceID={{referenceID}}' \
  --data-urlencode 'postLink={{postLink}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
שדות התגובה
שדהסוגחובהתיאור
$infractions_get_report_transactions_Response כן
$.oneOf[0] כן
$.oneOf[0].allOf[0]object כן
$.oneOf[0].allOf[0].RequestUserAliasstring כן
$.oneOf[0].allOf[0].RequestPathstring | null כן
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" כן
$.oneOf[0].allOf[0].ResponseCodeinteger כן
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring לא
$.oneOf[0].allOf[1]object כן
$.oneOf[0].allOf[1].Payloadobject כן
$.oneOf[0].allOf[1].Payload.transactionsarray כן
$.oneOf[0].allOf[1].Payload.transactions[]object לא
$.oneOf[0].allOf[1].Payload.transactions[].sourcestring ["transaction","custom_article"] כן
$.oneOf[0].allOf[1].Payload.transactions[].idinteger כן
$.oneOf[0].allOf[1].Payload.transactions[].amountCentsinteger כן
$.oneOf[0].allOf[1].Payload.transactions[].datestring כן
$.oneOf[0].allOf[1].Payload.transactions[].labelstring כן
$.oneOf[0].allOf[1].Payload.transactions[].statusstring ["PENDING","COMPLETED","RECORDED"] כן
$.oneOf[0].allOf[1].Payload.transactions[].formattedAmountstring כן
$.oneOf[0].allOf[1].Payload.hasMoreboolean כן
$.oneOf[1]object כן
$.oneOf[1].RequestUserAliasstring כן
$.oneOf[1].RequestPathstring | null כן
$.oneOf[1].RequestStatus = "Failed" כן
$.oneOf[1].ResponseCodeinteger כן
$.oneOf[1].ResponseMessageAPIResponseMessage כן
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[1].ResponseMessage.oneOf[1]array כן
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[1].ResponseMessage.oneOf[2]object כן
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[1].RequestImpersonatedByUserAliasstring לא
דוגמת תגובה
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/infractions/get_report_transactions",
    "RequestUserAlias": "example-user",
    "Payload": {
        "transactions": [],
        "hasMore": false
    }
}
תיעוד נקודת קצה קריא למכונה
POST

/v1/infractions/set_report

#
Submit a private infraction report with optional uploaded images, videos or PDFs. Attachments and later evidence-chat uploads are linked to the report and visible only to its reporter and authorized reviewers.

פרמטרים

שםסוגחובהברירת מחדלתיאור
submissionKey string כן — Stable unique retry identifier, 16-80 alphanumeric, underscore or hyphen characters.
reportJson string כן — JSON containing typeID, userID or userAlias, incidentDate (YYYY-MM-DD), required description, optional legacy evidence text, mediaIDs [owned ATMedia IDs], references [{type: seller|transaction|listing|chat|custom_article,id}], and subjectTransactionSource/subjectTransactionID. Transaction-based types require exactly one canonical source/ID pair at submission; other internal references are optional; staff must verify configured required references before approving an adverse finding. Chat references require the reporter's current access and remain private to the reporter and case reviewers. Legacy sellerID/sellerAlias are accepted when neither canonical user field is supplied.
isWritingRequest bool לא false Must be true to submit.
דוגמת בקשה (cURL)
curl --request POST \
  'https://he.appointmenttrader.com/v1/infractions/set_report' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'submissionKey={{submissionKey}}' \
  --data-urlencode 'reportJson={{reportJson}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
פרמטרים: reportJson
שדהסוגחובהתיאור
reportJsonstring (application/json) כן
reportJsonobject (JSON מפוענח) כן
reportJson.userIDinteger לא
reportJson.userAliasstring לא
reportJson.sellerIDinteger לא
reportJson.sellerAliasstring לא
reportJson.incidentDatestring כן
reportJson.descriptionstring כן
reportJson.evidencestring לא
reportJson.referencesarray לא
reportJson.references[]object לא
reportJson.references[].typestring ["seller","transaction","listing","chat","custom_article"] כן
reportJson.references[].idinteger כן
reportJson.mediaIDsarray לא
reportJson.mediaIDs[]DatabaseInteger לאInteger value; legacy MySQL reads may serialize it as a numeric string.
reportJson.mediaIDs[].oneOf[0]integer לא
reportJson.mediaIDs[].oneOf[1]string לא
reportJson.typeIDinteger כן
reportJson.subjectTransactionSourcestring ["transaction","custom_article"] לא
reportJson.subjectTransactionIDinteger לא
שדות התגובה
שדהסוגחובהתיאור
$infractions_set_report_Response כן
$.oneOf[0] כן
$.oneOf[0].allOf[0]object כן
$.oneOf[0].allOf[0].RequestUserAliasstring כן
$.oneOf[0].allOf[0].RequestPathstring | null כן
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" כן
$.oneOf[0].allOf[0].ResponseCodeinteger כן
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object כן
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring לא
$.oneOf[0].allOf[1]object כן
$.oneOf[0].allOf[1].Payloadobject כן
$.oneOf[0].allOf[1].Payload.caseIDinteger כן
$.oneOf[0].allOf[1].Payload.chatIDinteger כן
$.oneOf[1]object כן
$.oneOf[1].RequestUserAliasstring כן
$.oneOf[1].RequestPathstring | null כן
$.oneOf[1].RequestStatus = "Failed" כן
$.oneOf[1].ResponseCodeinteger כן
$.oneOf[1].ResponseMessageAPIResponseMessage כן
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null כן
$.oneOf[1].ResponseMessage.oneOf[1]array כן
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage לא
$.oneOf[1].ResponseMessage.oneOf[2]object כן
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage לא
$.oneOf[1].RequestImpersonatedByUserAliasstring לא
דוגמת תגובה
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/infractions/set_report",
    "RequestUserAlias": "example-user",
    "Payload": {
        "caseID": 0,
        "chatID": 0
    }
}
תיעוד נקודת קצה קריא למכונה