Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use this search bar to search topics within the CME ClearPort API.

Page Tree Search
rootPageCME ClearPort API

This page lists message samples associated with User Authentication requests and the API responses associated with those. These messages are relevant for HTTP submission only and not needed for MQ submissions.

Table of Contents
  

User Request Samples

Logon Request

An HTTP user requesting session-based logon utilizes the FIXML Application-level User Request Message with User Request Type 1 (Logon):

Code Block
languagehtml/xml
<?xml version="1.0" encoding="UTF-8"?>
<FIXML v="5.0 SP2" s="20090815" xv="109" cv="CME.0001">
	<UserReq UserReqID="123456" UserReqTyp="1" Username="user123" Password="User!Pass5">
		<Hdr SID="BRKR" SSub="user123" TID="CME" TSub="CPAPI"/>
	</UserReq>
</FIXML>

Logoff Request

Code Block
languagehtml/xml
<?xml version="1.0" encoding="UTF-8"?>
<FIXML v="5.0 SP2" s="20090815" xv="109" cv="CME.0001">
	<UserReq UserReqID="123456" UserReqTyp="2" Username="user123" Password="User!Pass5">
		<Hdr SID="BRKR" SSub="user123" TID="CME" TSub="CPAPI"/>
	</UserReq>
</FIXML>


User Response Samples

Successful Logon Response

Code Block
languagehtml/xml
<?xml version="1.0" encoding="UTF-8"?>
<FIXML v="5.0 SP2" s="20090815" xv="109" cv="CME.0001">
	<UserRsp UserReqID="123456" Username="user123" UserStat="1">
		<Hdr SID="CME" SSub="CPAPI" TID="BRKR" TSub="user123"/>
	</UserRsp>
</FIXML>

Successful Logoff Response

Code Block
languagehtml/xml
<?xml version="1.0" encoding="UTF-8"?>
<FIXML v="5.0 SP2" s="20090815" xv="109" cv="CME.0001">
	<UserRsp UserReqID="123456" Username="user123" UserStat="2">
		<Hdr SID="CME" SSub="CPAPI" TID="BRKR" TSub="user123"/>
	</UserRsp>
</FIXML>