ScrewZira API

Usage

There is no authentication for accessing the api, however a requests limitation applies for excessive usage.
Please do not abuse the api, or authentication and authorization steps will be implemented.

Send all data requests to:

http://api.screwzira.com/{Operation}

All requests must satisfy:

POST /{Operation} HTTP/1.1 
Content-Type: application/json

Operations

FindFilm

The request is decorated with "request" object containing the parameters

Request:
Parameter Required Valid Options Description
SearchType Mandatory FilmName, Subtitle, ImdbID Search type to perform
Version Mandatory "1.0" Latest build is 1.0
SearchPhrase Mandatory String ImdbID / Film name / Exact film release
Year Optional Numeric (yyyy) Year of release
Response:
Parameter Type Description
IsSuccess Boolean Determine whether the operation was successful or not
ErrorMessage String Provides and extra info regarding the result (may containe value even if IsSuccess=true)
Results Array of SubtitleResult Determine whether the operation was successful or not
SubtitleResult.SubtitleName String Definition Subtitle file name
SubtitleResult.Identifier String Definition The identifier used for Download request 
Example: POST http://api.screwzira.com/FindFilm
Request:
{"request":{"SearchPhrase": "tt1077258","SearchType": "ImdbID","Version":"1.0"}}

Response:
{"d": "{\"Results\":[{\"SubtitleName\":\"Planet.Terror.2007.Bluray.1080p.Dts.X264.Dxva-Eureka\",\"Identifier\":\"7707101F92D25DF4842947EAEA06DB7A\"},{\"SubtitleName\":\"Planet.Terror.2007.Scratch.Free.720p.BluRay.x264-SiNNERS\",\"Identifier\":\"CAF8E79930FFB84443242237AD8A80BC\"},{\"SubtitleName\":\"Planet.Terror.2007.720p.BluRay.x264.AC3-PsiX\",\"Identifier\":\"887CDEA3660C582F64A39DB13DD8295E\"}],\"IsSuccess\":true,\"ErrorMessage\":null}"}

FindSeries

The request is decorated with "request" object containing the parameters

Request:
Parameter Required Valid Options Description
SearchType Mandatory FilmName, Subtitle, ImdbID Search type to perform
Version Mandatory "1.0" Latest build is 1.0
SearchPhrase Mandatory String ImdbID / Film name / Exact release
Year Optional Numeric (yyyy) Year of release
Season Mandatory Numeric Season number
Episode Mandatory Numeric Episode number
Response:
Parameter Type Description
IsSuccess Boolean Determine whether the operation was successful or not
ErrorMessage String Provides and extra info regarding the result (may containe value even if IsSuccess=true)
Results Array of SubtitleResult Determine whether the operation was successful or not
SubtitleResult.SubtitleName String Definition Subtitle file name
SubtitleResult.Identifier String Definition The identifier used for Download request 
Example: POST http://api.screwzira.com/FindSeries
Request:
{"request":{"SearchPhrase": "Lost.S25E50.BRRip.XviD.AC3-ViSiON","SearchType": "Subtitle","Version":"1.0"}}

Response:
{"d": "{\"Results\":[],\"IsSuccess\":true,\"ErrorMessage\":\"אין תוצאות\"}"}

GetPredefinedLayouts

Request:
Parameter Required Valid Options Description
pairingCode Mandatory Fixed 7 Alphanumeric, case sensitive, string Pairing code is provided by the user from his profile page
Response:
Parameter Type Description
IsSuccess Boolean Determine whether the operation was successful or not
ErrorMessage String Provides and extra info regarding the result (may containe value even if IsSuccess=true)
Layouts Array of Layout Determine whether the operation was successful or not
Layout.LayoutName String Definition User predefined layout name
Layout.FontSize String Definition Font size layout property
Layout.HexColor String Definition Font color layout property 
Example: POST http://api.screwzira.com/GetPredefinedLayouts
Request:
{"pairingCode":"1234567"}

Response:
{"d": "{\"Layouts\":[{\"LayoutName\":\"טלויזיה\",\"FontSize\":\"500\",\"HexColor\":\"fff\"},{\"LayoutName\":\"מחשב\",\"FontSize\":\"250\",\"HexColor\":\"fff\"}],\"IsSuccess\":true,\"ErrorMessage\":null}"}

Download

The request is decorated with "request" object containing the parameters

Request:
Parameter Required Valid Options Description
SubtitleID Mandatory Fixed 7 Alphanumeric, case sensitive, string Pairing code is provided by the user from his profile page
FontSize Optional Numeric >0 Styles the font size (.sub format not supported), 0 - no styling
HexColor Optional 6 characters Hex string color, # prefix is optional, Styles the font color (.sub format not supported), empty string - no styling
Response:
Parameter Type Value
Content-Disposition String Header attachment; filename={filename}
ContentType String Header application/octet-stream
File Stream Body In case of length of 0 bytes, refer to [Content-Disposition][filename], filename will contain an error message 
Example: POST http://api.screwzira.com/Download
Request:
{"request":{"subtitleID": "887CDEA3660C582F64A39DB13DD8295E","fontSize": "500","hexColor":""}}

If you have any questions don't hesitate to contact us.