472
edits
API Docs: Difference between revisions
Jump to navigation
Jump to search
merge changes from draft
m (fixed wording to say response instead of request) |
(merge changes from draft) |
||
| Line 45: | Line 45: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
References: <ref name=":0">See [[Types]] for full list of possible categories. To get multiple, create an array with the format <code>["sponsor", intro"]</code>. </ref> <ref name=":1">Service to get segments for. See [https://wiki.sponsor.ajay.app/w/Types#service Types] for supported services</ref> <ref name=":2">Action Types: See [[Types]] for | References: <ref name=":0">See [[Types]] for full list of possible categories. To get multiple, create an array with the format <code>["sponsor", intro"]</code>. </ref> <ref name=":1">Service to get segments for. See [https://wiki.sponsor.ajay.app/w/Types#service Types] for supported services</ref> <ref name=":2">Action Types: See [[Types]] for possible values. Select multiple with the format <code>["skip","mute]</code></ref> | ||
'''Response''': | '''Response''': | ||
| Line 226: | Line 226: | ||
400: Bad Request (Your inputs are wrong/impossible) | 400: Bad Request (Your inputs are wrong/impossible) | ||
403: | 403: Reason given in request (moderation) | ||
----- | ----- | ||
| Line 325: | Line 325: | ||
preview: integer | preview: integer | ||
poi_highlight: integer | poi_highlight: integer | ||
filler: integer | filler: integer, | ||
exclusive_access: integer | |||
} | } | ||
// IF CHOSEN | // IF CHOSEN | ||
actionTypeCount: { // # of segments per type | actionTypeCount: { // # of segments per type | ||
skip: integer | skip: integer, | ||
mute: integer | mute: integer, | ||
full: integer, | |||
poi: integer | |||
} | } | ||
} | } | ||
| Line 511: | Line 514: | ||
<syntaxhighlight lang="ts"> | <syntaxhighlight lang="ts"> | ||
{ | { | ||
videoID: string | videoID: string, | ||
actionTypes: string[] // [3] | |||
// default [skip, mute] | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 519: | Line 524: | ||
{ | { | ||
categories: string[], // [1] | categories: string[], // [1] | ||
reason: string // Specified reason for the lock | reason: string, // Specified reason for the lock | ||
// Only the most recent reason will be returned | // Only the most recent reason will be returned | ||
actionTypes: string[] // [3] | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
References: <ref name=":0" /> | References: <ref name=":0" /> <ref name=":2" /> | ||
'''Error codes''': | '''Error codes''': | ||
| Line 573: | Line 579: | ||
category: string | category: string | ||
// OR | // OR | ||
categories: string[] | categories: string[], | ||
actionTypes: string[] // [3] | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
References: <ref name=":0" /> | References: <ref name=":0" /> <ref name=":2" /> | ||
'''Response''': | '''Response''': | ||
| Line 825: | Line 832: | ||
userID: string, // Local userID | userID: string, // Local userID | ||
categories: string[], // [1] | categories: string[], // [1] | ||
reason: string // Reason for lock | actionTypes: string[], // [3] | ||
reason: string, // Reason for lock | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
References: <ref name=":0" /> | References: <ref name=":0" /> <ref name=":2" /> | ||
'''Response''': | '''Response''': | ||