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

# Group Vectorapi
Group of all vectorapi-related resources.

## Vendor Carveout

Vendor Carveout deals with all country, dms carveout and dms_master carveout data which is restricted for Vendor(s).

## INXEX [/vectorapi/vendorcarveout/index{?vendorId,notClearedFlag,access_token}]

### Index Request to get data [GET]

+ Parameters

    + vendorId (required, varchar, `8869`)
    + notClearedFlag (required, varchar, `true`)
    + access_token (required, varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "envelope": {
      "header": {
          "apiVersion": "1.0",
          "baseUrl": "localhost",
          "httpStatusCode": 200
      },
      "request": "vendorcarveout/index?params=vectorapi&vendorcarveout&index&json&96896a6a3740a50f5817ae6ee2500638&7123&1&1&1",
      "response": {
        "territoryCarveout": {
            "cleared": [
                    {
                      "id": "188",
                      "name": "Zambia",
                      "abbrivation": "ZM",
                      "continent": "Africa"
                    },
                    {
                      "id": "189",
                      "name": "Zimbabwe",
                      "abbrivation": "ZW",
                      "continent": "Africa"
                    },
                   .
            ],
            "notCleared": [
                {
                    "id": "1",
                    "name": "USA",
                    "abbrivation": "US",
                    "continent": "North America"
                },
                {
                  "id": "2",
                  "name": "Canada",
                  "abbrivation": "CA",
                  "continent": "North America"
                },
               .
            ]
           },
           "dmsMasterCarveout": {
              "cleared": [
                   {
                      "customerMasterMasterId": "1",
                      "customerName": "iTunes"
                   },
                   {
                      "customerMasterMasterId": "2",
                      "customerName": "Napster"
                   },
                 .
              ],
              "notCleared": [
                 {
                    "customerMasterMasterId": "3",
                    "customerName": "MediaNet"
                 },
                .
              ]
          },
          "dmsCarveout": {
              "cleared": [
                  {
                     "customerId": "2",
                     "customerMasterMasterId": "1",
                     "name": "iTunes US"
                  },
                  {
                     "customerId": "3",
                     "customerMasterMasterId": null,
                     "name": "Alliance Entertainment"
                  },
               .
              ],      
             "notCleared": [                        
                 {
                     "customerId": "28085",
                     "customerMasterMasterId": "0",
                     "name": "Yogesh _Cutomer_Test"
                 },
                 .
            ]
         },
         "vendorId": "7123"
        }
    }
}

+ **Optional Parameters**

    + Optional Parameters : territoryType    

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

### Post [POST]

+ Parameters

    + data (required, varchar, `{"vendorId":6971, "countryIds":[1,2,3,4,5], "dmsMasterIds":[31,34,36], "dmsIds":[11,12,13]}`)
    + access_token (required, varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "envelope": {
    "header": {
      "apiVersion": "1.0",
      "baseUrl": "localhost",
      "httpStatusCode": 200
    },
    "request": "vendorcarveout/post?params=vectorapi&vendorcarveout&post&json&{\"vendorId\":6971, \"countryIds\":[1,2,3,4,5], \"dmsMasterIds\":[31,34,36], \"dmsIds\":[11,12,13]}&<some_token>",
    "response": {
      "vendorId": 6971
    }
  }
}