Affluenza REST API

<back to all web services

GetContractByIdRequest

The following routes are available for this service:
GET/contracts/{contractId}

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetContractByIdRequest HTTP/1.1 
Host: 107.22.237.214 
Content-Type: application/xml
Content-Length: length

<ContractTransport.GetContractByIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/M2M.Affluenza.Core.Rest.Transport">
  <AppKey xmlns="http://schemas.datacontract.org/2004/07/M2M.Affluenza.Core.Rest">0</AppKey>
  <Token xmlns="http://schemas.datacontract.org/2004/07/M2M.Affluenza.Core.Rest">String</Token>
  <ContractId>00000000-0000-0000-0000-000000000000</ContractId>
  <IsTemporary>false</IsTemporary>
</ContractTransport.GetContractByIdRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContractTransport.GetContractByIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/M2M.Affluenza.Core.Rest.Transport">
  <_x003C_ErrorMessage_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/M2M.Affluenza.Core.Rest">
    <_x003C_Message_x003E_k__BackingField>String</_x003C_Message_x003E_k__BackingField>
    <_x003C_StatusCode_x003E_k__BackingField>0</_x003C_StatusCode_x003E_k__BackingField>
  </_x003C_ErrorMessage_x003E_k__BackingField>
  <_x003C_Response_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/M2M.Affluenza.Core.Rest.Resource.Contract" xmlns="http://schemas.datacontract.org/2004/07/M2M.Affluenza.Core.Rest">
    <d2p1:Active>false</d2p1:Active>
    <d2p1:ContractCategory>String</d2p1:ContractCategory>
    <d2p1:ContractId>00000000-0000-0000-0000-000000000000</d2p1:ContractId>
    <d2p1:ContractObject xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </d2p1:ContractObject>
    <d2p1:CreatedBy>00000000-0000-0000-0000-000000000000</d2p1:CreatedBy>
    <d2p1:CreatedByName>String</d2p1:CreatedByName>
    <d2p1:CreatedOn>0001-01-01T00:00:00</d2p1:CreatedOn>
    <d2p1:DataSource>String</d2p1:DataSource>
    <d2p1:Forward>0</d2p1:Forward>
    <d2p1:HedgeAccounting>String</d2p1:HedgeAccounting>
    <d2p1:IsTemporary>false</d2p1:IsTemporary>
    <d2p1:MaturityDate>0001-01-01T00:00:00</d2p1:MaturityDate>
    <d2p1:ModifiedBy>00000000-0000-0000-0000-000000000000</d2p1:ModifiedBy>
    <d2p1:ModifiedByName>String</d2p1:ModifiedByName>
    <d2p1:ModifiedOn>0001-01-01T00:00:00</d2p1:ModifiedOn>
    <d2p1:Notional>0</d2p1:Notional>
    <d2p1:OperationStart>0001-01-01T00:00:00</d2p1:OperationStart>
    <d2p1:PortfolioId>00000000-0000-0000-0000-000000000000</d2p1:PortfolioId>
    <d2p1:PortfolioName>String</d2p1:PortfolioName>
    <d2p1:PortfolioParentName>String</d2p1:PortfolioParentName>
    <d2p1:Position>String</d2p1:Position>
    <d2p1:TemplateId>00000000-0000-0000-0000-000000000000</d2p1:TemplateId>
    <d2p1:Underlying>String</d2p1:Underlying>
  </_x003C_Response_x003E_k__BackingField>
  <_x003C_Status_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/M2M.Affluenza.Core.Rest">Success</_x003C_Status_x003E_k__BackingField>
</ContractTransport.GetContractByIdResponse>