FORMAT: 1A

# Group Vectorapi
Group of all vectorapi-related resources.

## Subaccount Dms Restriction

This API stores the customer ids i.e. substore ids which are restricted for subaccount. This API manages the add, update, delete and retrieve the restricted sub stores for subaccount.
Subaccount Dms Restriction resource  is having combinations of 'subaccount' and 'customer_master' (i.e. sub-store) fields.
These combinations says that customer master (i.e. a particular sub 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 Dms Restriction ' resource.

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

Fetch restricted dms for subaccount by request parameters.

### Index [GET]

+ Parameters

    + limit  (number, `2`)
    + access_token (varchar, `some token`)
  
+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "envelope": {
    "header": {
      "apiVersion": "1.0",
      "baseUrl": "testing.vapi.devorch.com",
      "httpStatusCode": 200
    },
    "request": "subaccountdmsrestriction/index?params=vectorapi&subaccountdmsrestriction&index&json&2&<some_token>",
    "response": {
      "subaccountDmsRestriction": [
        {
          "dmsRestrictionId": 21432,
          "lastUpdated": "2013-02-04 15:03:53",
          "updatedBy": 737,
          "subaccount": {
            "subaccountId": 15,
            "subaccountName": "override"
          },
          "dms": {
            "customerId": 2,
            "customerMasterMasterId": 1,
            "name": "iTunes US"
          }
        },
        {
          "dmsRestrictionId": 92789,
          "lastUpdated": "2014-03-18 22:14:11",
          "updatedBy": 693,
          "subaccount": {
            "subaccountId": 384,
            "subaccountName": "Small Stone Records"
          },
          "dms": {
            "customerId": 2,
            "customerMasterMasterId": 1,
            "name": "iTunes US"
          }
        }
      ]
    }
  }
}


+ **Other Optional Parameters**

    + Pagination Options : limit, offset
    + Sort Options : sort_by, sort_order (By default order is ASC)
    + Parameter options : subaccountId, dmsId


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

Get restricted dms for given subaccount.

+ Parameters

    + id (required,number, `12003`) ... An unique identifier of the subaccount_id.
    + 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": "testing.vapi.devorch.com",
      "httpStatusCode": 200
    },
    "request": "subaccountdmsrestriction/get?params=vectorapi&subaccountdmsrestriction&get&json&12003&<some_token>",
    "response": {
      "subaccountDmsRestriction": {
        "dmsRestrictionId": 12003,
        "lastUpdated": "2013-02-04 15:03:46",
        "updatedBy": 737,
        "Dms": {
          "customerId": 10035,
          "name": "121 Music BE",
          "customerMasterMasterId": 368
        },
        "Subaccount": {
          "subaccountId": 15,
          "subaccountName": "override"
        }
      }
    }
  }
}


+ **Required Parameters**

    + id - Primary key of subaccount_dms_restriction tabel.


## POST [/vectorapi/subaccountdmsrestriction/post{?data,access_token}]

Add restricted dms for given subaccount.

### Post [POST]

+ Parameters

    + data (varchar, `{"subaccountId":"1","dmsIds":[94,95]}`)
    + access_token (varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "envelope": {
    "header": {
      "apiVersion": "1.0",
      "baseUrl": "testing.vapi.devorch.com",
      "httpStatusCode": 200
    },
    "request": "subaccountdmsrestriction/post?params=vectorapi&subaccountdmsrestriction&post&json&{\"subaccountId\":\"1\",\"dmsIds\":[93, 94]}&<some_token>",
    "response": {
      "dmsRestrictionIds": [
        92800,
        92801
      ]
    }
  }
}



+ **Required Parameters**

    + subaccountId , dmsIds


## PUT [/vectorapi/subaccountdmsrestriction/put{?id,data,access_token}]

Update restricted dms for given subaccount.

### Put [PUT]

+ Parameters

    + id (required,number,`92804`)
    + data (varchar, `{"subaccountId":"1","dmsId":[96]}`)
    + access_token (varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "envelope": {
    "header": {
      "apiVersion": "1.0",
      "baseUrl": "testing.vapi.devorch.com",
      "httpStatusCode": 200
    },
    "request": "subaccountdmsrestriction/put?params=vectorapi&subaccountdmsrestriction&put&json&92804&{\"subaccountId\":\"1\",\"dmsId\":[96]}&<some_token>",
    "response": {
      "subaccountDmsRestriction": {
        "dmsRestrictionId": 92804,
        "lastUpdated": "2014-06-06 05:22:51",
        "updatedBy": "643",
        "Dms": {
          "customerId": 96,
          "name": "iTunes Italy",
          "customerMasterMasterId": 1
        },
        "Subaccount": {
          "subaccountId": 1,
          "subaccountName": "Label One"
        }
      }
    }
  }
}


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

### Delete [DELETE]

+ Parameters

    + id (required, number, `92805`)
    + access_token (required ,varchar, `some token`)

+ Request JSON Message
    
    + Headers

            Accept: application/json

+ Response 200 (application/json)

    + Body
{
  "envelope": {
    "header": {
      "apiVersion": "1.0",
      "baseUrl": "testing.vapi.devorch.com",
      "httpStatusCode": 200
    },
    "request": "subaccountdmsrestriction/delete?params=vectorapi&subaccountdmsrestriction&delete&json&92805&<some_token>",
    "response": {
      "dmsRestrictionId": "92805"
    }
  }
}


+ **Required Parameters**

    + id - Primary key of subaccount_dms_restriction table.