Online nu  

/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

Parameters

NaamTypeVerplichtStandaardBeschrijving
searchFilter string Nee "" filter criteria
restrictToSponsorableByUserAlias string Nee "" if set, only medals that can be sponsored by this userAlias will be returned
filterBy string Nee "Slug" comma seperated list of fields that should be included
pageSize int Nee 50 Defines how many results will be return per request
pageNumber int Nee 0 Defines which page should be returned
Voorbeeldverzoek (cURL)
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$medal_get_available_medal_categories_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Ja
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]string Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryNamestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedalDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListingsDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
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.

Parameters

NaamTypeVerplichtStandaardBeschrijving
userAlias string Ja — Profile owner to inspect.
medalCategorySlug string Ja — Medal category, not a tier slug.
afterUserID int Nee 0 Cursor from nextAfterUserID; zero starts the list.
pageSize int Nee 20 Number of visible sponsored users, from 1 to 50.
Voorbeeldverzoek (cURL)
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$medal_get_profile_sponsorships_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.profileAliasstring Ja
$.oneOf[0].allOf[1].Payload.medalCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.sponsor Ja
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].aliasstring Ja
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].avatarstring Ja
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].imageURLstring Ja
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].profileURLstring Ja
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].displayHTMLstring Ja
$.oneOf[0].allOf[1].Payload.sponsor.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.sponsoredUsersarray Ja
$.oneOf[0].allOf[1].Payload.sponsoredUsers[]object Nee
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].avatarstring Ja
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].imageURLstring Ja
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].profileURLstring Ja
$.oneOf[0].allOf[1].Payload.sponsoredUsers[].displayHTMLstring Ja
$.oneOf[0].allOf[1].Payload.hasMoreboolean Ja
$.oneOf[0].allOf[1].Payload.nextAfterUserID Ja
$.oneOf[0].allOf[1].Payload.nextAfterUserID.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.nextAfterUserID.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "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
    }
}
Machineleesbare endpointdocumentatie
POST

/v1/medal/set_request_medal_sponsorship

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
sponsorUserAlias string Ja — Alias Identifying the User to be sponsored
medalCategorySlug string Ja — Slug Identifying the Medal Category You Want to be Sponsored for
isWritingRequest bool Nee 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
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$medal_set_request_medal_sponsorship_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload = true Ja
$.oneOf[0].allOf[1].ResponseMessageobject Nee
$.oneOf[0].allOf[1].ResponseMessage.HumanReadablestring Ja
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariablesobject Ja
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatIDDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]integer Ja
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]string Ja
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURLstring Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "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
}
Machineleesbare endpointdocumentatie
POST

/v1/medal/set_sponsor_user

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
userAlias string Ja — Alias Identifying the User to be sponsored
medalCategorySlug string Ja — Slug Identifying the Medal Category You Want to Sponsor
isWritingRequest bool Nee 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
Voorbeeldverzoek (cURL)
curl --request POST \
  'https://nl.appointmenttrader.com/v1/medal/set_sponsor_user' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'medalCategorySlug={{medalCategorySlug}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$medal_set_sponsor_user_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payload = true Ja
$.oneOf[0].allOf[1].ResponseMessageobject Nee
$.oneOf[0].allOf[1].ResponseMessage.HumanReadablestring Ja
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariablesobject Ja
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatIDDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]integer Ja
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]string Ja
$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURLstring Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord
{
    "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
}
Machineleesbare endpointdocumentatie