POST api/bfg/v1/persons/activate-co-trading

Activate conditional order trading for a person. PIN gate mirrors legacy <c>COTrading.aspx</c> / <c>LoginSession.PINOptOut</c>: opted out → skip PIN; otherwise PIN is required and validated via ValidatePINAndAttemptLimits.

Request Information

URI Parameters

None.

Body Parameters

Person ID, client IP, and PIN (required unless person has PIN opt-out).

ActivateCoTradingRequest

Name	Type	Additional information
PersonID	integer	Required
IpAddress	string	Required String length: inclusive between 0 and 45
Pin	string	String length: inclusive between 0 and 10

Name

Description

Type

Additional information

PersonID

integer

Required

IpAddress

string

Required

String length: inclusive between 0 and 45

string

String length: inclusive between 0 and 10

Request Formats

application/json, text/json

Sample:

{
  "PersonID": 1,
  "IpAddress": "sample string 2",
  "Pin": "sample string 3"
}

application/xml, text/xml

Sample:

<ActivateCoTradingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Person">
  <IpAddress>sample string 2</IpAddress>
  <PersonID>1</PersonID>
  <Pin>sample string 3</Pin>
</ActivateCoTradingRequest>

Response Information

Resource Description

Activation result with HTTP status reflecting success, conflict, or failure.

ActivateCoTradingResponse

Name	Description	Type	Additional information
CoTradingEnabled		boolean	None.
Message		string	None.

Response Formats

application/json, text/json

Sample:

{
  "CoTradingEnabled": true,
  "Message": "sample string 1"
}

application/xml, text/xml

Sample:

<ActivateCoTradingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Person">
  <CoTradingEnabled>true</CoTradingEnabled>
  <Message>sample string 1</Message>
</ActivateCoTradingResponse>