POST api/BasicAPI/RemoveColleague

Request Information

URI Parameters

None.

Body Parameters

RemoveColleagueRequest
NameDescriptionTypeAdditional information
UserId

string

None.

ColleaguesToRemove

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserId": "sample string 1",
  "ColleaguesToRemove": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<RemoveColleagueRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StatCom26082020.ContextModel">
  <ColleaguesToRemove xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ColleaguesToRemove>
  <UserId>sample string 1</UserId>
</RemoveColleagueRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RemoveColleagueResponse
NameDescriptionTypeAdditional information
Data

DataOfRemoveColleague

None.

ReturnCode

string

None.

Description

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "Id": "sample string 1"
  },
  "ReturnCode": "sample string 1",
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:
<RemoveColleagueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StatCom26082020.ContextModel">
  <Description>sample string 2</Description>
  <ReturnCode>sample string 1</ReturnCode>
  <Data>
    <Id>sample string 1</Id>
  </Data>
</RemoveColleagueResponse>