POST api/Roles/AddBusinessRole

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BusinessID	integer	None.
UserID	integer	None.
RoleID	integer	None.
ActionType	integer	None.
RoleName	string	None.
ReportToRoleID	integer	None.
ReportToRoleIDs	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BusinessID": 1,
  "UserID": 2,
  "RoleID": 3,
  "ActionType": 4,
  "RoleName": "sample string 5",
  "ReportToRoleID": 6,
  "ReportToRoleIDs": "sample string 7"
}

application/xml, text/xml

Sample:

<AddBusinessRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ActionType>4</ActionType>
  <BusinessID>1</BusinessID>
  <ReportToRoleID>6</ReportToRoleID>
  <ReportToRoleIDs>sample string 7</ReportToRoleIDs>
  <RoleID>3</RoleID>
  <RoleName>sample string 5</RoleName>
  <UserID>2</UserID>
</AddBusinessRole>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/04/04 03:45:32",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>