Şu an çevrimiçi  

/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

Parametreler

AdTürGerekliVarsayılanAçıklama
searchFilter string HAYIR "" filter criteria
restrictToSponsorableByUserAlias string HAYIR "" if set, only medals that can be sponsored by this userAlias will be returned
filterBy string HAYIR "Slug" comma seperated list of fields that should be included
pageSize int HAYIR 50 Defines how many results will be return per request
pageNumber int HAYIR 0 Defines which page should be returned
İstek örneği (cURL)
curl --get \
  'https://tr.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}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$medal_get_available_medal_categories_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Evet
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]string HAYIR
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object HAYIR
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategorySlugstring Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryNamestring Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[0]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedalDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListingsDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[1]string Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Evet
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string HAYIR
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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": []
        }
    }
}
Makine tarafından okunabilir uç nokta belgeleri
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.

Parametreler

AdTürGerekliVarsayılanAçıklama
userAlias string Evet — Profile owner to inspect.
medalCategorySlug string Evet — Medal category, not a tier slug.
afterUserID int HAYIR 0 Cursor from nextAfterUserID; zero starts the list.
pageSize int HAYIR 20 Number of visible sponsored users, from 1 to 50.
İstek örneği (cURL)
curl --get \
  'https://tr.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}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$medal_get_profile_sponsorships_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payloadobject Evet
$.oneOf[0].allOf[1].Payload.profileAliasstring Evet
$.oneOf[0].allOf[1].Payload.medalCategorySlugstring Evet
$.oneOf[0].allOf[1].Payload.sponsor Evet
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0]object Evet
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].userIDinteger Evet
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].aliasstring Evet
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].avatarstring Evet
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].imageURLstring Evet
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].profileURLstring Evet
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].displayHTMLstring Evet
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[1]null Evet
$.oneOf[0].allOf[1].Payload.sponsoredUsersarray Evet
$.oneOf[0].allOf[1].Payload.sponsoredUsers[]object HAYIR
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].userIDinteger Evet
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].aliasstring Evet
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].avatarstring Evet
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].imageURLstring Evet
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].profileURLstring Evet
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].displayHTMLstring Evet
$.oneOf[0].allOf[1].Payload.hasMoreboolean Evet
$.oneOf[0].allOf[1].Payload.nextAfterUserID Evet
$.oneOf[0].allOf[1].Payload.nextAfterUserID.anyOf[0]integer Evet
$.oneOf[0].allOf[1].Payload.nextAfterUserID.anyOf[1]null Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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
    }
}
Makine tarafından okunabilir uç nokta belgeleri
POST

/v1/medal/set_request_medal_sponsorship

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

Parametreler

AdTürGerekliVarsayılanAçıklama
sponsorUserAlias string Evet — Alias Identifying the User to be sponsored
medalCategorySlug string Evet — Slug Identifying the Medal Category You Want to be Sponsored for
isWritingRequest bool HAYIR 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
İstek örneği (cURL)
curl --request POST \
  'https://tr.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}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$medal_set_request_medal_sponsorship_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payload = true Evet
$.oneOf[0].allOf[1].ResponseMessageobject HAYIR
$.oneOf[0].allOf[1].ResponseMessage.HumanReadablestring Evet
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariablesobject Evet
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatIDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]string Evet
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURLstring Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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
}
Makine tarafından okunabilir uç nokta belgeleri
POST

/v1/medal/set_sponsor_user

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

Parametreler

AdTürGerekliVarsayılanAçıklama
userAlias string Evet — Alias Identifying the User to be sponsored
medalCategorySlug string Evet — Slug Identifying the Medal Category You Want to Sponsor
isWritingRequest bool HAYIR 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
İstek örneği (cURL)
curl --request POST \
  'https://tr.appointmenttrader.com/v1/medal/set_sponsor_user' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'medalCategorySlug={{medalCategorySlug}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Dönen değer

JSON
See the shared response schema and synthetic example.
Yanıt alanları
AlanTürGerekliAçıklama
$medal_set_sponsor_user_Response Evet
$.oneOf[0] Evet
$.oneOf[0].allOf[0]object Evet
$.oneOf[0].allOf[0].RequestUserAliasstring Evet
$.oneOf[0].allOf[0].RequestPathstring | null Evet
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Evet
$.oneOf[0].allOf[0].ResponseCodeinteger Evet
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Evet
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring HAYIR
$.oneOf[0].allOf[1]object Evet
$.oneOf[0].allOf[1].Payload = true Evet
$.oneOf[0].allOf[1].ResponseMessageobject HAYIR
$.oneOf[0].allOf[1].ResponseMessage.HumanReadablestring Evet
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariablesobject Evet
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatIDDatabaseInteger EvetInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]integer Evet
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]string Evet
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURLstring Evet
$.oneOf[1]object Evet
$.oneOf[1].RequestUserAliasstring Evet
$.oneOf[1].RequestPathstring | null Evet
$.oneOf[1].RequestStatus = "Failed" Evet
$.oneOf[1].ResponseCodeinteger Evet
$.oneOf[1].ResponseMessageAPIResponseMessage Evet
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Evet
$.oneOf[1].ResponseMessage.oneOf[1]array Evet
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage HAYIR
$.oneOf[1].ResponseMessage.oneOf[2]object Evet
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage HAYIR
$.oneOf[1].RequestImpersonatedByUserAliasstring HAYIR
Yanıt örneği
{
    "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
}
Makine tarafından okunabilir uç nokta belgeleri