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

/v1/medal/

Manages All Medal and User Permission Related Functions
GET

/v1/medal/get_available_medal_categories

#
Searches all available medal categories on the platform

פרמטרים

שםסוגחובהברירת מחדלתיאור
searchFilter string לא "" filter criteria
restrictToSponsorableByUserAlias string לא "" if set, only medals that can be sponsored by this userAlias will be returned
filterBy string לא "Slug" comma seperated list of fields that should be included
pageSize int לא 50 Defines how many results will be return per request
pageNumber int לא 0 Defines which page should be returned
דוגמת בקשה (cURL)
curl --get \
  'https://he.appointmenttrader.com/v1/medal/get_available_medal_categories' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchFilter={{searchFilter}}' \
  --data-urlencode 'restrictToSponsorableByUserAlias={{restrictToSponsorableByUserAlias}}' \
  --data-urlencode 'filterBy={{filterBy}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
שדות התגובה
שדהסוגחובהתיאור
$medal_get_available_medal_categories_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.ATResponseObjectType = "NestedKeyValueList" כן
$.oneOf[0].allOf[1].Payload.ResponseBodyobject כן
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring כן
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray כן
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]string לא
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object לא
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategorySlugstring כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryNamestring כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[0]string כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[1]null כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[0]string כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[1]null כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[0]string כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[1]null כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[0]string כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[1]null כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedalDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListingsDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[0]integer כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[1]string כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray כן
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string לא
$.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/medal/get_available_medal_categories",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
תיעוד נקודת קצה קריא למכונה
GET

/v1/medal/get_profile_sponsorships

#
Returns the viewed user's current medal sponsor and directly sponsored users, with public identities only. Public-by-design: approved sponsorships are visible only when the caller can view both related profiles.

פרמטרים

שםסוגחובהברירת מחדלתיאור
userAlias string כן — Profile owner to inspect.
medalCategorySlug string כן — Medal category, not a tier slug.
afterUserID int לא 0 Cursor from nextAfterUserID; zero starts the list.
pageSize int לא 20 Number of visible sponsored users, from 1 to 50.
דוגמת בקשה (cURL)
curl --get \
  'https://he.appointmenttrader.com/v1/medal/get_profile_sponsorships' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'medalCategorySlug={{medalCategorySlug}}' \
  --data-urlencode 'afterUserID={{afterUserID}}' \
  --data-urlencode 'pageSize={{pageSize}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
שדות התגובה
שדהסוגחובהתיאור
$medal_get_profile_sponsorships_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.profileAliasstring כן
$.oneOf[0].allOf[1].Payload.medalCategorySlugstring כן
$.oneOf[0].allOf[1].Payload.sponsor כן
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0]object כן
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].userIDinteger כן
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].aliasstring כן
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].avatarstring כן
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].imageURLstring כן
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].profileURLstring כן
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].displayHTMLstring כן
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[1]null כן
$.oneOf[0].allOf[1].Payload.sponsoredUsersarray כן
$.oneOf[0].allOf[1].Payload.sponsoredUsers[]object לא
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].userIDinteger כן
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].aliasstring כן
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].avatarstring כן
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].imageURLstring כן
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].profileURLstring כן
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].displayHTMLstring כן
$.oneOf[0].allOf[1].Payload.hasMoreboolean כן
$.oneOf[0].allOf[1].Payload.nextAfterUserID כן
$.oneOf[0].allOf[1].Payload.nextAfterUserID.anyOf[0]integer כן
$.oneOf[0].allOf[1].Payload.nextAfterUserID.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/medal/get_profile_sponsorships",
    "RequestUserAlias": "example-user",
    "Payload": {
        "profileAlias": "synthetic-example",
        "medalCategorySlug": "synthetic-example",
        "sponsor": {
            "userID": 0,
            "alias": "synthetic-example",
            "avatar": "synthetic-example",
            "imageURL": "synthetic-example",
            "profileURL": "synthetic-example",
            "displayHTML": "synthetic-example"
        },
        "sponsoredUsers": [],
        "hasMore": false,
        "nextAfterUserID": 0
    }
}
תיעוד נקודת קצה קריא למכונה
POST

/v1/medal/set_request_medal_sponsorship

#
Request Medal Sponsorship will be asked to sponsor the medal defined below for you.

פרמטרים

שםסוגחובהברירת מחדלתיאור
sponsorUserAlias string כן — Alias Identifying the User to be sponsored
medalCategorySlug string כן — Slug Identifying the Medal Category You Want to be Sponsored for
isWritingRequest bool לא false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
דוגמת בקשה (cURL)
curl --request POST \
  'https://he.appointmenttrader.com/v1/medal/set_request_medal_sponsorship' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sponsorUserAlias={{sponsorUserAlias}}' \
  --data-urlencode 'medalCategorySlug={{medalCategorySlug}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
שדות התגובה
שדהסוגחובהתיאור
$medal_set_request_medal_sponsorship_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].Payload = true כן
$.oneOf[0].allOf[1].ResponseMessageobject לא
$.oneOf[0].allOf[1].ResponseMessage.HumanReadablestring כן
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariablesobject כן
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatIDDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]integer כן
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]string כן
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURLstring כן
$.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": {
        "HumanReadable": "Synthetic sponsorship request.",
        "ReturnVariables": {
            "RequestChatID": 1001,
            "RequestChatURL": "/modules/community/index.php?Tags[]=synthetic-chat"
        }
    },
    "RequestPath": "/v1/medal/set_request_medal_sponsorship",
    "RequestUserAlias": "example-user",
    "Payload": true
}
תיעוד נקודת קצה קריא למכונה
POST

/v1/medal/set_sponsor_user

#
Sponsor A Medal for will be recommended for the medal you define below.

פרמטרים

שםסוגחובהברירת מחדלתיאור
userAlias string כן — Alias Identifying the User to be sponsored
medalCategorySlug string כן — Slug Identifying the Medal Category You Want to Sponsor
isWritingRequest bool לא false all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request
דוגמת בקשה (cURL)
curl --request POST \
  'https://he.appointmenttrader.com/v1/medal/set_sponsor_user' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'medalCategorySlug={{medalCategorySlug}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

ערך מוחזר

JSON
See the shared response schema and synthetic example.
שדות התגובה
שדהסוגחובהתיאור
$medal_set_sponsor_user_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].Payload = true כן
$.oneOf[0].allOf[1].ResponseMessageobject לא
$.oneOf[0].allOf[1].ResponseMessage.HumanReadablestring כן
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariablesobject כן
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatIDDatabaseInteger כןInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]integer כן
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]string כן
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURLstring כן
$.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": {
        "HumanReadable": "Synthetic sponsorship request.",
        "ReturnVariables": {
            "RequestChatID": 1001,
            "RequestChatURL": "/modules/community/index.php?Tags[]=synthetic-chat"
        }
    },
    "RequestPath": "/v1/medal/set_sponsor_user",
    "RequestUserAlias": "example-user",
    "Payload": true
}
תיעוד נקודת קצה קריא למכונה