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

# Group Vectorapi
Group of all vectorapi-related resources.

## Subaccountdmsmasterrestriction

Subaccount Customer Master Restriction resource  is having combinations of 'subaccount' and 'customer_master_master' (i.e. store) fields.
These combinations says that customer master (i.e. a particular Store) is restricted for specified Subaccount (i.e. User category). 

Basically, Store should be accessible by limited and authorized users. So that they can modified related data based on privileges.
This API resource manages the addition, updation and deletion of ' Subaccount Customer Master Restriction ' resource.

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

### Post [POST]

+ Parameters

    + data (varchar, `{"subaccountId":1,"customerMasterMasterIds":[300,301,302,330,301]}`)
    + 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": "subaccountdmsmasterrestriction/post?params=vectorapi&subaccountdmsmasterrestriction&post&json&{\"subaccountId\":1,\"customerMasterMasterIds\":[300,301,302,330,301]}&<some_token>",
    "response": {
      "subaccountDmsMasterRestrictionIds": [
        27284,
        27285,
        27286,
        27287
      ]
    }
  }
}


+ **Required Parameters**

    + Required Parameters : customerMasterMasterIds, subaccountId

+ **Optional Parameters**

    + Parameters : NA 

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

### Put [POST]

+ Parameters

    + id (required, number, `27284`)
    + data (varchar, `{"subaccountId":1,"customerMasterMasterId":203}`)
    + access_token (optional, 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": "subaccountdmsmasterrestriction/put?params=vectorapi&subaccountdmsmasterrestriction&put&json&27284&{\"subaccountId\":1,\"customerMasterMasterId\":203}&<some_token>",
    "response": {
      "subaccountDmsMasterRestriction": {
        "dmsMasterRestrictionId": 27312,
        "lastUpdated": null,
        "updatedBy": "272",
        "subaccount": {
          "subaccountId": 1,
          "subaccountName": "Label One"
        },
        "customerMasterMaster": {
          "customerMasterMasterId": 203,
          "customerName": "Ericsson AB"
        }
      }
    }
  }
}


+ **Required Parameters**

    + Required Parameters : id - dms_master_restriction_id - primary key,customerMasterMasterId 

+ **Optional Parameters**

    + Parameters : subaccountId 


## Get [/vectorapi/subaccountdmsmasterrestriction/get{?id,access_token}]

### Get [GET]

+ Parameters

    + id (number, `8112`) ... dms_master_restriction_id - primary key
    + 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": "subaccountdmsmasterrestriction/get?params=vectorapi&subaccountdmsmasterrestriction&get&json&8112&<some_token>",
    "response": {
      "subaccountDmsMasterRestriction": {
        "dmsMasterRestrictionId": 8112,
        "lastUpdated": "2013-02-04 11:18:34",
        "updatedBy": 756,
        "subaccount": {
          "subaccountId": 6,
          "subaccountName": "Midwest Entertainment"
        },
        "customerMasterMaster": {
          "customerMasterMasterId": 368,
          "customerName": "121 Music1"
        }
      }
    }
  }
}

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

### Index [GET]

+ Parameters

    + customerMasterMasterId (required, number, `10`)
    + limit (optional, number, `5`)
    + 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": "subaccountdmsmasterrestriction/index?params=vectorapi&subaccountdmsmasterrestriction&index&json&10&5&<some_token>",
    "response": {
      "subaccountDmsMasterRestriction": [
        {
          "dmsMasterRestrictionId": 9360,
          "lastUpdated": "2013-02-04 15:03:11",
          "updatedBy": 737,
          "subaccount": {
            "subaccountId": 15,
            "subaccountName": "override"
          },
          "customerMasterMaster": {
            "customerMasterMasterId": 10,
            "customerName": "Ruckus"
          }
        },
        {
          "dmsMasterRestrictionId": 11169,
          "lastUpdated": "2013-02-07 12:24:42",
          "updatedBy": 528,
          "subaccount": {
            "subaccountId": 17,
            "subaccountName": "Fat Wreck Records Text"
          },
          "customerMasterMaster": {
            "customerMasterMasterId": 10,
            "customerName": "Ruckus"
          }
        },
        {
          "dmsMasterRestrictionId": 23741,
          "lastUpdated": "2013-10-07 05:45:29",
          "updatedBy": 751,
          "subaccount": {
            "subaccountId": 4274,
            "subaccountName": "Susan Lawly"
          },
          "customerMasterMaster": {
            "customerMasterMasterId": 10,
            "customerName": "Ruckus"
          }
        },
        {
          "dmsMasterRestrictionId": 23258,
          "lastUpdated": "2013-09-13 09:45:36",
          "updatedBy": 299,
          "subaccount": {
            "subaccountId": 6765,
            "subaccountName": "Whirlwind Records"
          },
          "customerMasterMaster": {
            "customerMasterMasterId": 10,
            "customerName": "Ruckus"
          }
        },
        {
          "dmsMasterRestrictionId": 21591,
          "lastUpdated": "2013-07-23 16:24:32",
          "updatedBy": 737,
          "subaccount": {
            "subaccountId": 7123,
            "subaccountName": "Metal Mayhem"
          },
          "customerMasterMaster": {
            "customerMasterMasterId": 10,
            "customerName": "Ruckus"
          }
        }
      ]
    }
  }
}

+ **Other Optional Parameters**

    + Optional Parameters : limit, offset, pageNumber, totalRecords
    + Sort Options : columnName, orderBy
    + Parameter options: subaccountId,customerMasterMasterId.

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

### Delete [DELETE]

+ Parameters

    + id (number, `27283`) ... dms_master_restriction_id - primary key
    + access_token (varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "envelope": {
    "header": {
      "apiVersion": "1.0",
      "baseUrl": "192.168.0.55",
      "httpStatusCode": 200
    },
    "request": "subaccountdmsmasterrestriction/delete?params=vectorapi&subaccountdmsmasterrestriction&delete&json&27283&<some_token>",
    "response": {
      "dmsMasterRestrictionId": "27283"
    }
  }
}