Get the station's clearance
readDayparts the station clears, units a day, deadlines and contacts.
GET
https://affiliates.radioworkflow.com/api/v1/affiliations/{id}/clearanceRead: this changes nothing.
What the station has agreed to carry for this network: each daypart it clears with its days, window and units a day, the shows it carries, the deadline rule for signing, how audio is delivered, the network contact and the station's people with their roles.
Authentication
Path parameters
idstring1 to 64 charactersrequiredThe affiliation id from
GET /v1/affiliations: one station's relationship with one network.Response
200
application/jsonThe clearance, shows, deadline rule, contacts and people.Response schema
deadlineRulestringrequirednetworkContactobjectrequirednetworkContact.namestringrequirednetworkContact.titlestringrequirednetworkContact.emailstringrequirednetworkContact.phonestringrequiredaudioDeliverystringrequiredDaypartClearance7 fields
namestringrequireddaysstringrequiredwindowStartinteger (0 to 1439)requiredwindowEndinteger (0 to 1439)requiredmaxPerDayintegerrequiredvehicleIdstringrequiredunitsByWeekdayinteger[]requiredShowVehicle11 fields
idstringrequirednamestringrequiredkind"daily" | "weekend"requireddaysinteger[] (0 to 6)requiredhoursinteger (0 to 24)requiredbreakCountintegerrequiredusualStartinteger (0 to 1439)optionalusualEndinteger (0 to 1439)optionallocalBreaksobject[]requiredlocalBreaks[].hourinteger (1 to 24)requiredlocalBreaks[].breakNumberinteger (1 to 1000)requiredPerson7 fields
namestringrequiredemailstringrequiredrolestringrequiredcanSignbooleanrequiredlastSeenstringrequiredtitlestringrequiredroleCode"view" | "report" | "sign"requiredErrors
403forbiddenThe key is valid but cannot do this for this affiliation: the affiliation is not one of the key's, or the person who made the key lacks the role.
Possible on every endpoint
401invalid_principalThe key is missing, malformed, unknown, revoked or expired; all of these answer the same way.
429rate_limitedToo many requests: the key's bucket, a daily limit or the failed sign-in brake refused this one.
503unavailableThe service is not available right now: it could not be reached, or it is not set up yet.
Rate limits
Failed sign-ins per address10 per minute
portal:authBurst per key60 per minute
portal:keyCalls per key600 per 10 minutes
key:{prefix}MCP
An assistant calls this as the tool
get_clearance, with the same input as one object. The MCP servercurl -X GET 'https://affiliates.radioworkflow.com/api/v1/affiliations/srn-ksmt/clearance' \ -H "Authorization: Bearer $AFFILIATE_API_KEY"
{
"clearance": [
{
"name": "Summit ROS (ROS)",
"days": "Mon to Fri",
"windowStart": 360,
"windowEnd": 1139,
"maxPerDay": 2,
"vehicleId": "demo-ros",
"unitsByWeekday": [
2,
2,
2,
2,
2,
0,
0
]
}
],
"shows": [
{
"id": "show-wd",
"name": "The Summit Show",
"kind": "daily",
"days": [
0,
1,
2,
3,
4
],
"hours": 5,
"breakCount": 19,
"usualStart": 1140,
"usualEnd": 1439,
"localBreaks": [
{
"hour": 2,
"breakNumber": 5
}
]
}
],
"deadlineRule": "Friday after the broadcast week, 5:00 PM",
"networkContact": {
"name": "Marcus Bell",
"title": "Network Traffic Coordinator",
"email": "affiliates@summit-sample.example",
"phone": "(555) 010-2440"
},
"audioDelivery": "Delivered by the network's spot delivery service",
"people": [
{
"name": "Dana Ortiz",
"email": "traffic@ksmt-sample.example",
"role": "Traffic Director",
"canSign": true,
"lastSeen": "Now",
"title": "Traffic Director",
"roleCode": "sign"
}
]
}