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

# Group Vectorapi
Group of all vectorapi-related resources.

## Customercurrency

Customer currency resource is deal with DMS related currencies. User may assign currencies to a particular pricing scheme. But this is the resource which would allow user to come up with currencies at DMS level. 

In simple term, user is allow to have a bunch of territories with respect to their currencies for a particular DMS (i.e store). Here we can have different combinations of country and its currency assigned to DMS.

## Post [/vectorapi/dmsgenre/post{?data,access_token}]

### Post [POST]

+ Parameters

    + data (varchar, `{"customerMasterMasterId":10,"dmsMasterGenre": "DmsGenre1","dmsMasterSubgenre":"DmsSubgenre1","subgenreCode":"HJ3432jhG435345"}`)
    + 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": "dmsgenre/post?params=vectorapi&dmsgenre&post&json&{\"customerMasterMasterId\":10,\"dmsMasterGenre\": \"DmsGenre1\",\"dmsMasterSubgenre\":\"DmsSubgenre1\",\"subgenreCode\":\"HJ3432jhG435345\"}&<some_token>",
    "response": {
      "dmsGenre": {
        "dmsMasterGenreId": 1075,
        "dmsMasterSubgenreId": 30342
      }
    }
  }
}


+ **Required Parameters**

    + Required Parameters : customerMasterMasterId, dmsMasterGenreId or dmsMasterGenre

+ **Optional Parameters**

    + Parameters : genreCode,subgenreCode,dmsMasterSubgenre


## Put [/vectorapi/dmsgenre/put{?data,access_token}]

### Put - to update dms master genre data. [POST]

+ Parameters
    
    + data (varchar, `{"customerMasterMasterId":10,"dmsMasterGenreId": 1075,"dmsMasterGenre":"Test Genre new","genreCode":"NMBHGH324"}`)    
    + 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": "dmsgenre/put?params=vectorapi&dmsgenre&put&json&{\"customerMasterMasterId\":10,\"dmsMasterGenreId\": 1075,\"dmsMasterGenre\":\"Test Genre new\",\"genreCode\":\"NMBHGH324\"}&<some_token>",
    "response": {
      "dmsGenre": {
        "dmsMasterGenreId": 1075
      }
    }
  }
}

+ **Required Parameters**

    + Required Parameters : dmsMasterGenreId

+ **Optional Parameters**

    + Parameters : genreCode,dmsMasterGenre


## Put [/vectorapi/dmsgenre/put{?data,access_token}]

### Put - to update dms master subgenre data. [POST]

+ Parameters
    
    + data (varchar, `{"customerMasterMasterId":10,"dmsMasterSubgenreId": 1075,"dmsMasterSubgenre":"Test SubGenre new","subGenreCode":"NMBGGHGH324"}`)    
    + 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": "dmsgenre/post?params=vectorapi&dmsgenre&post&json&{\"customerMasterMasterId\":10,\"dmsMasterGenre\": \"DmsGenre1\",\"dmsMasterSubgenre\":\"DmsSubgenre1\",\"subgenreCode\":\"HJ3432jhG435345\"}&<some_token>",
    "response": {
      "dmsGenre": {
        "dmsMasterGenreId": 1075,
        "dmsMasterSubgenreId": 30342
      }
    }
  }
}


+ **Required Parameters**

    + Required Parameters : dmsMasterSubgenreId

+ **Other Optional Parameters**

    + Optional Parameters : dmsMasterSubgenre, subGenreCode


## GET [/vectorapi/dmsgenre/get{?id,access_token}]

### GET [GET]

+ Parameters
    
    + id (required, number, `1057`)    
    + 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": "dmsgenre/get?params=vectorapi&dmsgenre&get&json&1057&<some_token>",
    "response": {
      "dmsGenre": {
        "dmsMasterGenreId": 1057,
        "dmsMasterGenre": "Dubstep",
        "genreCode": null,
        "dmsGenreMapping": null,
        "customerMasterMaster": {
          "customerMasterMasterId": 213,
          "customerName": "Beatport Digital Download Network"
        }
      }
    }
  }
}

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

### Index [GET]

+ Parameters

    + customerMasterMasterId (required, number, `1`)
    + limit (optional, number, `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": "dmsgenre/index?params=vectorapi&dmsgenre&index&json&1&10&<some_token>",
    "response": {
      "dmsGenre": [
        {
          "dmsMasterGenreId": 65,
          "dmsMasterGenre": "Devotional & Spiritual",
          "genreCode": "DEVOTIONAL-SPIRITUAL-00",
          "dmsMasterSubgenre": [],
          "customerMasterMaster": {
            "customerMasterMasterId": 1,
            "customerName": "iTunes"
          }
        },
        {
          "dmsMasterGenreId": 7,
          "dmsMasterGenre": "Maitri New",
          "genreCode": "92",
          "dmsMasterSubgenre": [
            {
              "dmsMasterSubgenreId": 6,
              "dmsMasterSubgenre": "test123",
              "subgenreCode": null
            }
          ],
          "customerMasterMaster": {
            "customerMasterMasterId": 1,
            "customerName": "iTunes"
          }
        },
        {
          "dmsMasterGenreId": 64,
          "dmsMasterGenre": "Manthan",
          "genreCode": "manthanmehta-01",
          "dmsMasterSubgenre": [
            {
              "dmsMasterSubgenreId": 1754,
              "dmsMasterSubgenre": "Mehta",
              "subgenreCode": null
            }
          ],
          "customerMasterMaster": {
            "customerMasterMasterId": 1,
            "customerName": "iTunes"
          }
        }
      ]
    }
  }
}

+ **Other Optional Parameters**

    + Optional Parameters : limit, offset, pageNumber, totalRecords
    + Sort Options : columnName, orderBy
    + Parameter options (filter): customerMasterMasterId, dmsMasterGenreId, dmsMasterGenre, dmsMasterSubgenreId , dmsMasterSubgenre 

## Delete [/vectorapi/dmsgenre/delete{?dmsMasterGenreId,access_token}]

### Delete [DELETE]

+ Parameters

    + dmsMasterGenreId (number, `1076`) ... primary key of dms_master_genre table.
    + 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": "dmsgenre/delete?params=vectorapi&dmsgenre&delete&json&1076&<some_token>",
    "response": {
      "dmsGenre": {
        "dmsMasterGenreId": "1076"
      }
    }
  }
}
