DELETE api/APIAuthenticate/DeleteUserModule

Delete a user module and all its APIs/entities, or delete only specific APIs/entities from a user module.

Request Information

URI Parameters

None.

Body Parameters

DeleteUserModuleRequestModel with UserID, Name, DeleteModule, APIURLs, EntityObjs

Name	Type	Additional information
UserTypeID	integer	None.
Name	string	None.
DeleteModule	boolean	None.
APIURLs	Collection of DeleteUserModuleApiModel	None.
EntityObjs	Collection of DeleteUserModuleEntityModel	None.

Request Formats

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

Sample:

{
  "userTypeID": 1,
  "name": "sample string 1",
  "deleteModule": true,
  "apiurLs": [
    {
      "apiurl": "sample string 1"
    },
    {
      "apiurl": "sample string 1"
    }
  ],
  "entityObjs": [
    {
      "obj": "sample string 1"
    },
    {
      "obj": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<DeleteUserModuleRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.UserModule">
  <APIURLs>
    <DeleteUserModuleApiModel>
      <APIURL>sample string 1</APIURL>
    </DeleteUserModuleApiModel>
    <DeleteUserModuleApiModel>
      <APIURL>sample string 1</APIURL>
    </DeleteUserModuleApiModel>
  </APIURLs>
  <DeleteModule>true</DeleteModule>
  <EntityObjs>
    <DeleteUserModuleEntityModel>
      <Obj>sample string 1</Obj>
    </DeleteUserModuleEntityModel>
    <DeleteUserModuleEntityModel>
      <Obj>sample string 1</Obj>
    </DeleteUserModuleEntityModel>
  </EntityObjs>
  <Name>sample string 1</Name>
  <UserTypeID>1</UserTypeID>
</DeleteUserModuleRequestModel>

multipart/form-data

Sample:

<DeleteUserModuleRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.RequestModel.UserModule"><APIURLs><DeleteUserModuleApiModel><APIURL>sample string 1</APIURL></DeleteUserModuleApiModel><DeleteUserModuleApiModel><APIURL>sample string 1</APIURL></DeleteUserModuleApiModel></APIURLs><DeleteModule>true</DeleteModule><EntityObjs><DeleteUserModuleEntityModel><Obj>sample string 1</Obj></DeleteUserModuleEntityModel><DeleteUserModuleEntityModel><Obj>sample string 1</Obj></DeleteUserModuleEntityModel></EntityObjs><Name>sample string 1</Name><UserTypeID>1</UserTypeID></DeleteUserModuleRequestModel>

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>