POST api/APIAuthenticate/SaveUserModuleBundle

Bulk save user module with APIs and entities in one call.

Request Information

URI Parameters

None.

Body Parameters

User module bundle request model

SaveUserModuleBundleRequestModel
NameDescriptionTypeAdditional information
Modules

Collection of UserModuleBulkModel

Required

Request Formats

application/json, text/json, text/plain, text/html

Sample:
{
  "modules": [
    {
      "userTypeID": 1,
      "name": "sample string 1",
      "url": "sample string 2",
      "isTemplate": true,
      "displayOrder": 1,
      "apIs": [
        {
          "apiurl": "sample string 1"
        },
        {
          "apiurl": "sample string 1"
        }
      ],
      "entities": [
        {
          "obj": "sample string 1",
          "w": true,
          "r": true,
          "d": true
        },
        {
          "obj": "sample string 1",
          "w": true,
          "r": true,
          "d": true
        }
      ]
    },
    {
      "userTypeID": 1,
      "name": "sample string 1",
      "url": "sample string 2",
      "isTemplate": true,
      "displayOrder": 1,
      "apIs": [
        {
          "apiurl": "sample string 1"
        },
        {
          "apiurl": "sample string 1"
        }
      ],
      "entities": [
        {
          "obj": "sample string 1",
          "w": true,
          "r": true,
          "d": true
        },
        {
          "obj": "sample string 1",
          "w": true,
          "r": true,
          "d": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<SaveUserModuleBundleRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.UserModule">
  <Modules>
    <UserModuleBulkModel>
      <APIs>
        <UserModuleApiModel>
          <apiurl>sample string 1</apiurl>
        </UserModuleApiModel>
        <UserModuleApiModel>
          <apiurl>sample string 1</apiurl>
        </UserModuleApiModel>
      </APIs>
      <DisplayOrder>1</DisplayOrder>
      <Entities>
        <UserModuleEntityModel>
          <D>true</D>
          <Obj>sample string 1</Obj>
          <R>true</R>
          <W>true</W>
        </UserModuleEntityModel>
        <UserModuleEntityModel>
          <D>true</D>
          <Obj>sample string 1</Obj>
          <R>true</R>
          <W>true</W>
        </UserModuleEntityModel>
      </Entities>
      <IsTemplate>true</IsTemplate>
      <Name>sample string 1</Name>
      <URL>sample string 2</URL>
      <UserTypeID>1</UserTypeID>
    </UserModuleBulkModel>
    <UserModuleBulkModel>
      <APIs>
        <UserModuleApiModel>
          <apiurl>sample string 1</apiurl>
        </UserModuleApiModel>
        <UserModuleApiModel>
          <apiurl>sample string 1</apiurl>
        </UserModuleApiModel>
      </APIs>
      <DisplayOrder>1</DisplayOrder>
      <Entities>
        <UserModuleEntityModel>
          <D>true</D>
          <Obj>sample string 1</Obj>
          <R>true</R>
          <W>true</W>
        </UserModuleEntityModel>
        <UserModuleEntityModel>
          <D>true</D>
          <Obj>sample string 1</Obj>
          <R>true</R>
          <W>true</W>
        </UserModuleEntityModel>
      </Entities>
      <IsTemplate>true</IsTemplate>
      <Name>sample string 1</Name>
      <URL>sample string 2</URL>
      <UserTypeID>1</UserTypeID>
    </UserModuleBulkModel>
  </Modules>
</SaveUserModuleBundleRequestModel>

multipart/form-data

Sample:
<SaveUserModuleBundleRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.UserModule"><Modules><UserModuleBulkModel><APIs><UserModuleApiModel><apiurl>sample string 1</apiurl></UserModuleApiModel><UserModuleApiModel><apiurl>sample string 1</apiurl></UserModuleApiModel></APIs><DisplayOrder>1</DisplayOrder><Entities><UserModuleEntityModel><D>true</D><Obj>sample string 1</Obj><R>true</R><W>true</W></UserModuleEntityModel><UserModuleEntityModel><D>true</D><Obj>sample string 1</Obj><R>true</R><W>true</W></UserModuleEntityModel></Entities><IsTemplate>true</IsTemplate><Name>sample string 1</Name><URL>sample string 2</URL><UserTypeID>1</UserTypeID></UserModuleBulkModel><UserModuleBulkModel><APIs><UserModuleApiModel><apiurl>sample string 1</apiurl></UserModuleApiModel><UserModuleApiModel><apiurl>sample string 1</apiurl></UserModuleApiModel></APIs><DisplayOrder>1</DisplayOrder><Entities><UserModuleEntityModel><D>true</D><Obj>sample string 1</Obj><R>true</R><W>true</W></UserModuleEntityModel><UserModuleEntityModel><D>true</D><Obj>sample string 1</Obj><R>true</R><W>true</W></UserModuleEntityModel></Entities><IsTemplate>true</IsTemplate><Name>sample string 1</Name><URL>sample string 2</URL><UserTypeID>1</UserTypeID></UserModuleBulkModel></Modules></SaveUserModuleBundleRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel with result

CommonResponseDataModel
NameDescriptionTypeAdditional information
ReturnID

integer

Required

Message

string

Required

Successful

boolean

Required

Code

integer

None.

TotalRecord

integer

None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:
{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>