FORMAT: 1A

# Group Vectorapi
Group of all vectorapi-related resources.

## Genre Mapping

Genre mapping is the concept which provides association between particular store's genre data and orchard's genre data.

dmsMasterGenre is having details where master genre name is assigned to a particular customer master master. And dmsMasterGenre details (means combination of customer master master and master genre) is assigned to one of the orchard's genre. This details are available with dmsGenreMapping table.

This resource manages all information which relates store's genre with orchard's genre.

## Index [/vectorapi/genremapping/index{?limit,access_token}]

### Index [GET]

+ Parameters

    + limit  (optional,number, `2`)
    + access_token (required,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": "genremapping/index?params=vectorapi&genremapping&index&json&2&<some_token>",
    "response": {
      "dmsSubgenreMapping": [
        {
          "dmsSubgenreMappingId": 472,
          "dmsMasterSubgenre": {
            "dmsMasterSubgenreId": 507,
            "dmsMasterSubgenre": "80's",
            "subgenreCode": null,
            "dmsMasterGenre": {
              "dmsMasterGenreId": 30,
              "dmsMasterGenre": "Rock",
              "genreCode": null
            }
          },
          "orchardSubgenre": {
            "orchardId": 511,
            "name": "80's",
            "genre": {
              "genreId": 1,
              "genre": "Rock"
            }
          }
        },
        {
          "dmsSubgenreMappingId": 1315,
          "dmsMasterSubgenre": {
            "dmsMasterSubgenreId": 1381,
            "dmsMasterSubgenre": "80's",
            "subgenreCode": null,
            "dmsMasterGenre": {
              "dmsMasterGenreId": 59,
              "dmsMasterGenre": "Rock",
              "genreCode": null
            }
          },
          "orchardSubgenre": {
            "orchardId": 511,
            "name": "80's",
            "genre": {
              "genreId": 1,
              "genre": "Rock"
            }
          }
        }
      ],
      "countForDmsSubgenreMapping": "3385",
      "dmsGenreMapping": [
        {
          "dmsGenreMappingId": 472,
          "dmsMasterGenre": {
            "dmsMasterGenreId": 30,
            "dmsMasterGenre": "Rock",
            "genreCode": null
          },
          "orchardSubgenre": {
            "orchardId": 511,
            "name": "80's",
            "genre": {
              "genreId": 1,
              "genre": "Rock"
            }
          }
        },
        {
          "dmsGenreMappingId": 1315,
          "dmsMasterGenre": {
            "dmsMasterGenreId": 59,
            "dmsMasterGenre": "Rock",
            "genreCode": null
          },
          "orchardSubgenre": {
            "orchardId": 511,
            "name": "80's",
            "genre": {
              "genreId": 1,
              "genre": "Rock"
            }
          }
        }
      ],
      "countForDmsGenremapping": "5188"
    }
  }
}
    
+ **Other Request Examples**

    + 1.vectorapi/genremapping/index?customerMasterMasterId=555
    + 2.vectorapi/genremapping/index?orchardGenreId=2
    + 3.vectorapi/genremapping/index?orchardSubenreId=26 
    
+ **Other Optional Parameters**

    + Optional Parameters : customerMasterMasterId,orchardSubgenreId,orchardGenreId
    + Pagination Options : limit, offset
    + Sort Option : sortBy,sortOrder
   

## While saving dms_genre_mapping  [/vectorapi/genremapping/post{?data,access_token}]

To insert data in update dms_genre_mapping  

### Post [POST]

+ Parameters

    + data (varchar, `{"customerMasterMasterId":4, "dmsMasterGenreId":630, "orchardSubgenreId":1}`)
    + access_token (required,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": "genremapping/post?params=vectorapi&genremapping&post&json&{\"customerMasterMasterId\":1, \"dmsMasterGenreId\":7, \"orchardSubgenreId\":1}&<some_token>",
    "response": {
      "genreMapping": {
        "dmsGenreMapping": {
          "dmsGenreMappingId": 5198,
          "orchardSubgenre": {
            "orchardId": 1,
            "subgenreName": "Americana"
          },
          "dmsMasterGenre": {
            "dmsMasterGenreId": 7,
            "dmsMasterGenreName": "Maitri New"
          }
        }
      }
    }
  }
}

## While saving dms_sub_genre_mapping POST [/vectorapi/genremapping/post{?data,access_token}]

To update dms_subgenre_mapping. 

### Post [POST]

+ Parameters

    + data (varchar, `{"customerMasterMasterId":1,"dmsMasterGenreId":10, "dmsMasterSubgenreId":15, "orchardSubgenreId":1}`)
    + access_token (required,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": "genremapping/post?params=vectorapi&genremapping&post&json&{\"customerMasterMasterId\":1, \"dmsMasterGenreId\":7, \"orchardSubgenreId\":1}&<some_token>",
    "response": {
      "genreMapping": {
        "dmsGenreMapping": {
          "dmsGenreMappingId": 5198,
          "orchardSubgenre": {
            "orchardId": 1,
            "subgenreName": "Americana"
          },
          "dmsMasterGenre": {
            "dmsMasterGenreId": 7,
            "dmsMasterGenreName": "Maitri New"
          }
        }
      }
    }
  }
}
       
  
+ **Required Parameters**

    + Required Parameters : customerMasterMasterId,dmsMasterGenreId or dmsMasterSubgenreId,orchardSubgenreId


## while updating dms_genre_mapping [/vectorapi/genremapping/put{?data,access_token}]

To update dms_genre_mapping 

### Put [POST]

+ Parameters

    + data (varchar,`{"dmsGenreMappingId":10,"dmsMasterGenreId":65, "orchardSubgenreId":10}`)
    + access_token (required,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": "genremapping/put?params=vectorapi&genremapping&put&json&{\"dmsGenreMappingId\":10,\"dmsMasterGenreId\":65, \"orchardSubgenreId\":10}&<some_token>",
    "response": {
      "genreMapping": {
        "dmsGenreMapping": {
          "dmsGenreMappingId": 10,
          "orchardSubgenre": {
            "orchardId": 10,
            "subgenreName": "Brit-Pop"
          },
          "dmsMasterGenre": {
            "dmsMasterGenreId": 65,
            "dmsMasterGenreName": "Devotional & Spiritual"
          }
        }
      }
    }
  }
}


## while updating dms_subgenre_mapping [/vectorapi/genremapping/put{?data,access_token}]

To update dms_subgenre_mapping 

### Put [POST]

+ Parameters

    + data (varchar, `{"dmsSubgenreMappingId":7, "dmsMasterSubgenreId":10, "orchardSubgenreId":1}`)
    + access_token (required,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": "genremapping/put?params=vectorapi&genremapping&put&json&{\"dmsSubgenreMappingId\":7, \"dmsMasterSubgenreId\":10, \"orchardSubgenreId\":1}&<some_token>",
    "response": {
      "genreMapping": {
        "dmsSubgenreMapping": {
          "dmsSubgenreMappingId": 7,
          "orchardSubgenre": {
            "orchardId": 1,
            "subgenreName": "Americana"
          },
          "dmsMasterSubgenre": {
            "dmsMasterSubgenreId": 10,
            "dmsMasterSubgenreName": "Biography"
          }
        }
      }
    }
  }
}
    
    
+ **Other Optional Parameters**

    + Required Parameters : dmsGenreMappingId or dmsSubgenreMappingId
    + Optional Parameters : dmsMasterGenreId or   dmsMasterSubgenreId,orchardSubgenreId


## Delete [/vectorapi/genremapping/delete{?dmsGenreMappingId,access_token}]

### Delete [GET]

+ Parameters

    + dmsGenreMappingId (required, number, `271`)
    + access_token (required ,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": "genremapping/delete?params=vectorapi&genremapping&delete&json&274&<some_token>",
    "response": {
      "genreMapping": true
    }
  }
}
    
+ **Required Parameters**

    + Required Parameters : dmsGenreMappingId or dmsSubgenreMappingId