POST api/APIAuthenticate/SaveUserModule

Save user module only (step 1 of 2-step process).

Request Information

URI Parameters

None.

Body Parameters

User module request model

Name	Type	Additional information
UserModuleID	integer	None.
UserTypeID	integer	None.
Name	string	Required
URL	string	Required
IsTemplate	boolean	None.
DisplayOrder	integer	None.

Request Formats

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

Sample:

{
  "userModuleID": 1,
  "userTypeID": 1,
  "name": "sample string 1",
  "url": "sample string 2",
  "isTemplate": true,
  "displayOrder": 1
}

application/xml, text/xml

Sample:

<SaveUserModuleRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.UserModule">
  <DisplayOrder>1</DisplayOrder>
  <IsTemplate>true</IsTemplate>
  <Name>sample string 1</Name>
  <URL>sample string 2</URL>
  <UserModuleID>1</UserModuleID>
  <UserTypeID>1</UserTypeID>
</SaveUserModuleRequestModel>

multipart/form-data

Sample:

<SaveUserModuleRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.UserModule"><DisplayOrder>1</DisplayOrder><IsTemplate>true</IsTemplate><Name>sample string 1</Name><URL>sample string 2</URL><UserModuleID>1</UserModuleID><UserTypeID>1</UserTypeID></SaveUserModuleRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel with result

CommonResponseDataModel

Name	Type	Additional 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>