Difference between revisions of "API Remove Sharing Link"
IVSWikiBlue (talk | contribs) (Created page with "This API call will delete a previously created sharing link for an existing recording. ===Resource URL=== <pre>http://valt.example.com/api/v3/records/{recordingid}/share/deac...") |
IVSWikiBlue (talk | contribs) (→Parameters) |
||
| Line 18: | Line 18: | ||
===Parameters=== | ===Parameters=== | ||
| − | + | No parameters are required for this API call but an empty set must be defined. | |
| − | No parameters are required for this API call. | + | <nowiki> |
| + | { } | ||
| + | </nowiki> | ||
===Response=== | ===Response=== | ||
Latest revision as of 13:51, 20 December 2022
This API call will delete a previously created sharing link for an existing recording.
Contents
Resource URL
http://valt.example.com/api/v3/records/{recordingid}/share/deactivate
Replace {recordingid} with the actual id number of the recording. Recordings are numbered sequentially when added to VALT.
Resource Information
| Method | POST |
| Response Type | JSON |
| Authentication Required | Yes |
Parameters
No parameters are required for this API call but an empty set must be defined.
{ }
Response
| Code | Reason |
|---|---|
| 200 | Request Successful |
| 401 | Unauthorized |
| 404 | Recording Not Found |
| data | |
|---|---|
| message | share removed |
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/records/614/share/deactivate?access_token=e82632d19c523678fea3d1016c6df9e9
Successful Response
{
"data":{
"message": "share removed"
}
}
Failure Response
{
"error":{
"code": 404
}
}
