GET api/UserModule/GetUserModuleByID?userModuleID={userModuleID}

Get a user module by its ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
userModuleID	UserModuleID to fetch	integer	Required

Body Parameters

None.

Response Information

Resource Description

User module details

GetUserModuleByIDResponseModel

Name	Type	Additional information
TotalRecord	integer	None.
UserModuleID	integer	None.
UserTypeID	integer	None.
UserTypeName	string	None.
Name	string	None.
URL	string	None.
IsTemplate	boolean	None.
DisplayOrder	integer	None.
APIs	Collection of UserModuleApiDataModel	None.
Entities	Collection of UserModuleEntityDataModel	None.

Response Formats

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

Sample:

{
  "totalRecord": 1,
  "userModuleID": 2,
  "userTypeID": 3,
  "userTypeName": "sample string 4",
  "name": "sample string 5",
  "url": "sample string 6",
  "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:

<GetUserModuleByIDResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.DataModel.UserModule">
  <APIs>
    <UserModuleApiDataModel>
      <APIURL>sample string 1</APIURL>
    </UserModuleApiDataModel>
    <UserModuleApiDataModel>
      <APIURL>sample string 1</APIURL>
    </UserModuleApiDataModel>
  </APIs>
  <DisplayOrder>1</DisplayOrder>
  <Entities>
    <UserModuleEntityDataModel>
      <D>true</D>
      <Obj>sample string 1</Obj>
      <R>true</R>
      <W>true</W>
    </UserModuleEntityDataModel>
    <UserModuleEntityDataModel>
      <D>true</D>
      <Obj>sample string 1</Obj>
      <R>true</R>
      <W>true</W>
    </UserModuleEntityDataModel>
  </Entities>
  <IsTemplate>true</IsTemplate>
  <Name>sample string 5</Name>
  <TotalRecord>1</TotalRecord>
  <URL>sample string 6</URL>
  <UserModuleID>2</UserModuleID>
  <UserTypeID>3</UserTypeID>
  <UserTypeName>sample string 4</UserTypeName>
</GetUserModuleByIDResponseModel>

multipart/form-data

Sample:

<GetUserModuleByIDResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.DataModel.UserModule"><APIs><UserModuleApiDataModel><APIURL>sample string 1</APIURL></UserModuleApiDataModel><UserModuleApiDataModel><APIURL>sample string 1</APIURL></UserModuleApiDataModel></APIs><DisplayOrder>1</DisplayOrder><Entities><UserModuleEntityDataModel><D>true</D><Obj>sample string 1</Obj><R>true</R><W>true</W></UserModuleEntityDataModel><UserModuleEntityDataModel><D>true</D><Obj>sample string 1</Obj><R>true</R><W>true</W></UserModuleEntityDataModel></Entities><IsTemplate>true</IsTemplate><Name>sample string 5</Name><TotalRecord>1</TotalRecord><URL>sample string 6</URL><UserModuleID>2</UserModuleID><UserTypeID>3</UserTypeID><UserTypeName>sample string 4</UserTypeName></GetUserModuleByIDResponseModel>