En ligne  

/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

Paramètres

NomTypeObligatoireValeur par défautDescription
searchFilter string Non "" filter criteria
restrictToSponsorableByUserAlias string Non "" if set, only medals that can be sponsored by this userAlias will be returned
filterBy string Non "Slug" comma seperated list of fields that should be included
pageSize int Non 50 Defines how many results will be return per request
pageNumber int Non 0 Defines which page should be returned
Exemple de requête (cURL)
curl --get \
  'https://fr.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}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$medal_get_available_medal_categories_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Oui
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]string Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Non
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategorySlugstring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryNamestring Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[0]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedalDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListingsDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[1]string Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Oui
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string Non
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "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": []
        }
    }
}
Documentation du point de terminaison lisible par machine
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.

Paramètres

NomTypeObligatoireValeur par défautDescription
userAlias string Oui — Profile owner to inspect.
medalCategorySlug string Oui — Medal category, not a tier slug.
afterUserID int Non 0 Cursor from nextAfterUserID; zero starts the list.
pageSize int Non 20 Number of visible sponsored users, from 1 to 50.
Exemple de requête (cURL)
curl --get \
  'https://fr.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}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$medal_get_profile_sponsorships_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payloadobject Oui
$.oneOf[0].allOf[1].Payload.profileAliasstring Oui
$.oneOf[0].allOf[1].Payload.medalCategorySlugstring Oui
$.oneOf[0].allOf[1].Payload.sponsor Oui
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0]object Oui
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].userIDinteger Oui
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].aliasstring Oui
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].avatarstring Oui
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].imageURLstring Oui
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].profileURLstring Oui
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].displayHTMLstring Oui
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[1]null Oui
$.oneOf[0].allOf[1].Payload.sponsoredUsersarray Oui
$.oneOf[0].allOf[1].Payload.sponsoredUsers[]object Non
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].userIDinteger Oui
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].aliasstring Oui
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].avatarstring Oui
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].imageURLstring Oui
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].profileURLstring Oui
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].displayHTMLstring Oui
$.oneOf[0].allOf[1].Payload.hasMoreboolean Oui
$.oneOf[0].allOf[1].Payload.nextAfterUserID Oui
$.oneOf[0].allOf[1].Payload.nextAfterUserID.anyOf[0]integer Oui
$.oneOf[0].allOf[1].Payload.nextAfterUserID.anyOf[1]null Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "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
    }
}
Documentation du point de terminaison lisible par machine
POST

/v1/medal/set_request_medal_sponsorship

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

Paramètres

NomTypeObligatoireValeur par défautDescription
sponsorUserAlias string Oui — Alias Identifying the User to be sponsored
medalCategorySlug string Oui — Slug Identifying the Medal Category You Want to be Sponsored for
isWritingRequest bool Non 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
Exemple de requête (cURL)
curl --request POST \
  'https://fr.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}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$medal_set_request_medal_sponsorship_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payload = true Oui
$.oneOf[0].allOf[1].ResponseMessageobject Non
$.oneOf[0].allOf[1].ResponseMessage.HumanReadablestring Oui
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariablesobject Oui
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatIDDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]integer Oui
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]string Oui
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURLstring Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "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
}
Documentation du point de terminaison lisible par machine
POST

/v1/medal/set_sponsor_user

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

Paramètres

NomTypeObligatoireValeur par défautDescription
userAlias string Oui — Alias Identifying the User to be sponsored
medalCategorySlug string Oui — Slug Identifying the Medal Category You Want to Sponsor
isWritingRequest bool Non 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
Exemple de requête (cURL)
curl --request POST \
  'https://fr.appointmenttrader.com/v1/medal/set_sponsor_user' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'medalCategorySlug={{medalCategorySlug}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retour

JSON
See the shared response schema and synthetic example.
Champs de réponse
ChampTypeObligatoireDescription
$medal_set_sponsor_user_Response Oui
$.oneOf[0] Oui
$.oneOf[0].allOf[0]object Oui
$.oneOf[0].allOf[0].RequestUserAliasstring Oui
$.oneOf[0].allOf[0].RequestPathstring | null Oui
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Oui
$.oneOf[0].allOf[0].ResponseCodeinteger Oui
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Oui
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Non
$.oneOf[0].allOf[1]object Oui
$.oneOf[0].allOf[1].Payload = true Oui
$.oneOf[0].allOf[1].ResponseMessageobject Non
$.oneOf[0].allOf[1].ResponseMessage.HumanReadablestring Oui
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariablesobject Oui
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatIDDatabaseInteger OuiInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]integer Oui
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]string Oui
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURLstring Oui
$.oneOf[1]object Oui
$.oneOf[1].RequestUserAliasstring Oui
$.oneOf[1].RequestPathstring | null Oui
$.oneOf[1].RequestStatus = "Failed" Oui
$.oneOf[1].ResponseCodeinteger Oui
$.oneOf[1].ResponseMessageAPIResponseMessage Oui
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Oui
$.oneOf[1].ResponseMessage.oneOf[1]array Oui
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Non
$.oneOf[1].ResponseMessage.oneOf[2]object Oui
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Non
$.oneOf[1].RequestImpersonatedByUserAliasstring Non
Exemple de réponse
{
    "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
}
Documentation du point de terminaison lisible par machine