FORMAT: 1A

# Group Vectorapi
Group of all vectorapi-related resources.

## Filmchapter

'Film Chapter' is the concept which is related with the 'Film Releases'. A Film may consist of one or more parts such as part 1, part 2,..etc.
These parts are known as 'Chapters'. This resource deals with all the functionality (add,edit, delete) related to 'Film Chapters'.

## Index [/vectorapi/filmchapter/index{?release_id,access_token}]

### Index [GET]

+ Parameters

    + release_id  (required, number, `483598`)
    + access_token (required, varchar, `some token`)
  
+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "filmChapter": {
    "chapter_data": [
      {
        "marker_id": 21880,
        "chapter_number": 1,
        "chapter_name": "Chapter1",
        "time": "00:00:00:00"
      },
      {
        "marker_id": 21881,
        "chapter_number": 2,
        "chapter_name": "Chapter2",
        "time": "00:00:00:01"
      }
    ],
    "release_id": 483598,
    "track_id": 6061759
  }
}


+ **Other Optional Parameters**

    + Pagination Options : limit, offset, pageNumber, totalRecords
    + Sort Options : columnName, orderBy
    + Required Parameter : release_id


## GET [/vectorapi/filmchapter{?id,release_id,access_token}]

+ Parameters

    + id (required,number, `21880`) ... An unique identifier of the track_video _marker.
    + release_id (required,number, `483598`) ... An unique identifier of the track_video _marker.
    + access_token (required,varchar, `some token`)


### Get [GET]

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)
    + Body
{
  "envelope": {
    "header": {
      "apiVersion": "1.0",
      "baseUrl": "192.168.0.56",
      "httpStatusCode": 200
    },
    "request": "filmchapter/get?params=vectorapi&filmchapter&get&21880&483598&<some_token>&json",
    "response": {
      "filmChapter": {
        "markerId": 21880,
        "Track": {
          "__isInitialized__": false
        },
        "locationRemove": null,
        "nameRemove": null,
        "chapterNumber": 1,
        "chapterName": "Chapter1",
        "time": "00:00:00:00",
        "type": "chapter",
        "startTimecode": null,
        "endTimecode": null,
        "isrc": null,
        "usages": null,
        "cline": null,
        "pline": null,
        "artists": null,
        "songName": null,
        "cueNumber": null
      }
    }
  }
}

+ **Required Parameters**

    + Required Parameters : id,release_id

## POST [/vectorapi/filmchapter{?data,release_id,access_token}]

### Post [POST]

+ Parameters

    + data (varchar, `{"release_id":483598,"chapter_data":{"chapter_name":"checkmate","time":"00:00:00:01","video_marker_id":0}}`)
    + release_id (required, number,`483598`)
    + access_token (varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "response": {
    "Response": "success"
  }
}


+ **Required Parameters**

    + Required Parameters : release_id, id,chapter_name,time

## Delete [/vectorapi/filmchapter{?id,release_id,access_token}]

### Delete [DELETE]

+ Parameters

    + id (required,number, `21880`) ... An unique identifier of the track_video _marker.
    + release_id (required,number, `483598`) ... An unique identifier of the track_video _marker.  
    + access_token (required ,varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "response": "success"
}

+ **Required Parameters**

    + Required Parameters : release_id, id