FORMAT: 1A
HOST: http://apiblueprint.vapi.devorch.com/

# Group Vectorapi
Group of all vectorapi-related resources.

## Tvseries

Tvseries resource is responsible for retrieving the Tvseries list.

## Index [/vectorapi/tvseries/index{?vendorId,access_token}]

### Index [GET]

+ Parameters
    
    + access_token (varchar, `some token`)
    + vendorId (number, `7123`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
    
            {
              "envelope": {
                "header": {
                  "apiVersion": "1.0",
                  "baseUrl": "vapi.alpha.devorch.com",
                  "httpStatusCode": 200
                },
                "request": "tvseries/index?params=vectorapi&tvseries&index&json&7123&<some_token>",
                "response": {
                  "tvSeries": [
                    {
                      "seriesId": 1,
                      "seriesName": "test"
                    },
                    {
                      "seriesId": 2,
                      "seriesName": "test2"
                    }
                  ]
                }
              }
            }

+ Other Optional Parameters

    + Optional Parameters : limit, offset, totalRecords, with_artist_mapping
    + Sort Options : sortBy, sortOrder
    + Parameter options (filter): vendorId

## Get [/vectorapi/tvseries/get{?seriesId,access_token}]

### Get [GET]

+ Parameters
    
    + access_token (required, varchar, `some token`)
    + seriesId (required, number, `2`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
    
            {
              "envelope": {
                "header": {
                  "apiVersion": "1.0",
                  "baseUrl": "vapi.alpha.devorch.com",
                  "httpStatusCode": 200
                },
                "request": "tvseries/get?params=vectorapi&tvseries&get&json&2&<some_token>",
                "response": {
                      "seriesId": 2,
                      "seriesName": "test2"
                }
              }
            }


## Post [/vectorapi/tvseries/post{?seriesName,vendorId,access_token}]

### Post - Request to store tvseries for new series  [POST]

+ Parameters
    + seriesName (varchar, `ISpy`)
    + vendorId (number, `7123`)
    + access_token (varchar, `some token`)

+ Request JSON Message

    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body

            {
              "envelope": {
                "header": {
                  "apiVersion": "1.0",
                  "baseUrl": "vapi.alpha.devorch.com",
                  "httpStatusCode": 200
                },
                "request": "tvseries/post?params=vectorapi&tvseries&post&json&ISpy&7123&<some_token>",
                "response": {
                    "seriesId": 1,
                    "seriesName": ISpy,
                    "vendorId": 7123
                }
              }
            }
            
## Put [/vectorapi/tvseries/put{?seriesId,seriesName,access_token}]

### Put - Request to edit tvseries for existing series  [PUT]

+ Parameters
    + seriesId (number, `1`)
    + seriesName (varchar, `ISpynew`)
    + access_token (varchar, `some token`)

+ Request JSON Message

    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body

            {
              "envelope": {
                "header": {
                  "apiVersion": "1.0",
                  "baseUrl": "vapi.alpha.devorch.com",
                  "httpStatusCode": 200
                },
                "request": "tvseries/put?params=vectorapi&tvseries&put&json&1&ISpynew&<some_token>",
                "response": {
                    "seriesId": 1,
                    "seriesName": ISpynew,
                    "vendorId": 7123
                }
              }
            }

## Delete [/vectorapi/tvseries/delete{?id,access_token}]

### Delete [DELETE]

+ Parameters

    + id (number, `275`)
    + access_token (varchar, `some token`)

+ Request JSON Message

    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body

            {
              "envelope": {
                "header": {
                  "apiVersion": "1.0",
                  "baseUrl": "vapi.alpha.devorch.com",
                  "httpStatusCode": 200
                },
                "request": "tvseries/delete?params=vectorapi&tvseries&delete&json&232&<some_token>",
                "response": true
              }
            }