WS_Contract Web Service

WS_Contract

Click here for a complete list of operations.

GetContract

Get contract object for given contract ID.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /TruxWeb/WSCust_Contract/WS_Contract.asmx HTTP/1.1
Host: trux.organicdiversion.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.trux.com/GetContract"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <Credentials xmlns="http://www.trux.com">
      <sAccountID>string</sAccountID>
      <sAuthCode>string</sAuthCode>
      <isAuthCodeEncrypted>boolean</isAuthCodeEncrypted>
      <areParametersEncrypted>boolean</areParametersEncrypted>
      <encryptedParameterNames>
        <string>string</string>
        <string>string</string>
      </encryptedParameterNames>
      <requireEncryptedResponse>boolean</requireEncryptedResponse>
      <encryptionMethod>string</encryptionMethod>
      <keyInfo>
        <encryptedKey>string</encryptedKey>
        <encryptionPublicKey>string</encryptionPublicKey>
      </keyInfo>
      <publicAuthKey>string</publicAuthKey>
    </Credentials>
  </soap:Header>
  <soap:Body>
    <GetContract xmlns="http://www.trux.com">
      <sLoginComp>string</sLoginComp>
      <contractId>int</contractId>
      <renew>boolean</renew>
    </GetContract>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body />
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /TruxWeb/WSCust_Contract/WS_Contract.asmx HTTP/1.1
Host: trux.organicdiversion.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <Credentials xmlns="http://www.trux.com">
      <sAccountID>string</sAccountID>
      <sAuthCode>string</sAuthCode>
      <isAuthCodeEncrypted>boolean</isAuthCodeEncrypted>
      <areParametersEncrypted>boolean</areParametersEncrypted>
      <encryptedParameterNames>
        <string>string</string>
        <string>string</string>
      </encryptedParameterNames>
      <requireEncryptedResponse>boolean</requireEncryptedResponse>
      <encryptionMethod>string</encryptionMethod>
      <keyInfo>
        <encryptedKey>string</encryptedKey>
        <encryptionPublicKey>string</encryptionPublicKey>
      </keyInfo>
      <publicAuthKey>string</publicAuthKey>
    </Credentials>
  </soap12:Header>
  <soap12:Body>
    <GetContract xmlns="http://www.trux.com">
      <sLoginComp>string</sLoginComp>
      <contractId>int</contractId>
      <renew>boolean</renew>
    </GetContract>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetContractResponse xmlns="http://www.trux.com">
      <GetContractResult>
        <Id>int</Id>
        <Number>string</Number>
        <Customer>int</Customer>
        <Site>int</Site>
        <Prospect>int</Prospect>
        <ProspectSite>int</ProspectSite>
        <CreateUser>string</CreateUser>
        <CreationDate>dateTime</CreationDate>
        <SalesRep>int</SalesRep>
        <Status>string</Status>
        <PoNum>string</PoNum>
        <Type>string</Type>
        <Comments>string</Comments>
        <EffectiveDate>dateTime</EffectiveDate>
        <StartDate>dateTime</StartDate>
        <ExpiryDate>dateTime</ExpiryDate>
        <GuaranteeDate>dateTime</GuaranteeDate>
        <CustomerPrintName>string</CustomerPrintName>
        <CustomerTitle>string</CustomerTitle>
        <CustomerSignDate>dateTime</CustomerSignDate>
        <RenewFrom>int</RenewFrom>
        <PrintCopies>int</PrintCopies>
        <ApprovedBy>string</ApprovedBy>
        <ApproveDate>dateTime</ApproveDate>
        <EstimatedRevenue>decimal</EstimatedRevenue>
        <LegalId>int</LegalId>
        <ContractDetails>
          <TxContractDetail>
            <Id>int</Id>
            <Type>string</Type>
            <Size>decimal</Size>
            <UnitOfMeasure>string</UnitOfMeasure>
            <Quantity>decimal</Quantity>
            <Compact>boolean</Compact>
            <CustomerOwn>boolean</CustomerOwn>
            <WeekCode>int</WeekCode>
            <MaxLifts>decimal</MaxLifts>
            <WeekDayFrequency>int</WeekDayFrequency>
            <DemurrageDays>int</DemurrageDays>
            <DemmurageRateDecimal>decimal</DemmurageRateDecimal>
            <PoRquired>boolean</PoRquired>
            <Note1>string</Note1>
            <ScheduledDays>string</ScheduledDays>
            <Service>int</Service>
            <OriginalId>int</OriginalId>
            <Finalized>boolean</Finalized>
            <ReinstateDate>dateTime</ReinstateDate>
            <StopReason>string</StopReason>
            <ChangeReason>string</ChangeReason>
            <Action>int</Action>
            <PriceClass>int</PriceClass>
            <ContractRate xsi:nil="true" />
            <ContractRateActivityMaterial xsi:nil="true" />
          </TxContractDetail>
          <TxContractDetail>
            <Id>int</Id>
            <Type>string</Type>
            <Size>decimal</Size>
            <UnitOfMeasure>string</UnitOfMeasure>
            <Quantity>decimal</Quantity>
            <Compact>boolean</Compact>
            <CustomerOwn>boolean</CustomerOwn>
            <WeekCode>int</WeekCode>
            <MaxLifts>decimal</MaxLifts>
            <WeekDayFrequency>int</WeekDayFrequency>
            <DemurrageDays>int</DemurrageDays>
            <DemmurageRateDecimal>decimal</DemmurageRateDecimal>
            <PoRquired>boolean</PoRquired>
            <Note1>string</Note1>
            <ScheduledDays>string</ScheduledDays>
            <Service>int</Service>
            <OriginalId>int</OriginalId>
            <Finalized>boolean</Finalized>
            <ReinstateDate>dateTime</ReinstateDate>
            <StopReason>string</StopReason>
            <ChangeReason>string</ChangeReason>
            <Action>int</Action>
            <PriceClass>int</PriceClass>
            <ContractRate xsi:nil="true" />
            <ContractRateActivityMaterial xsi:nil="true" />
          </TxContractDetail>
        </ContractDetails>
        <ContractNote>
          <TxContractNote>
            <User>string</User>
            <Note>string</Note>
            <SystemNote>boolean</SystemNote>
          </TxContractNote>
          <TxContractNote>
            <User>string</User>
            <Note>string</Note>
            <SystemNote>boolean</SystemNote>
          </TxContractNote>
        </ContractNote>
        <ContractAttachment>
          <TxContractAttachment>
            <FileName>string</FileName>
            <Note>string</Note>
            <File>base64Binary</File>
            <AttachmentType>int</AttachmentType>
          </TxContractAttachment>
          <TxContractAttachment>
            <FileName>string</FileName>
            <Note>string</Note>
            <File>base64Binary</File>
            <AttachmentType>int</AttachmentType>
          </TxContractAttachment>
        </ContractAttachment>
      </GetContractResult>
    </GetContractResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /TruxWeb/WSCust_Contract/WS_Contract.asmx/GetContract?sLoginComp=string&contractId=string&renew=string HTTP/1.1
Host: trux.organicdiversion.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<TxContract xmlns="http://www.trux.com">
  <Id>int</Id>
  <Number>string</Number>
  <Customer>int</Customer>
  <Site>int</Site>
  <Prospect>int</Prospect>
  <ProspectSite>int</ProspectSite>
  <CreateUser>string</CreateUser>
  <CreationDate>dateTime</CreationDate>
  <SalesRep>int</SalesRep>
  <Status>string</Status>
  <PoNum>string</PoNum>
  <Type>string</Type>
  <Comments>string</Comments>
  <EffectiveDate>dateTime</EffectiveDate>
  <StartDate>dateTime</StartDate>
  <ExpiryDate>dateTime</ExpiryDate>
  <GuaranteeDate>dateTime</GuaranteeDate>
  <CustomerPrintName>string</CustomerPrintName>
  <CustomerTitle>string</CustomerTitle>
  <CustomerSignDate>dateTime</CustomerSignDate>
  <RenewFrom>int</RenewFrom>
  <PrintCopies>int</PrintCopies>
  <ApprovedBy>string</ApprovedBy>
  <ApproveDate>dateTime</ApproveDate>
  <EstimatedRevenue>decimal</EstimatedRevenue>
  <LegalId>int</LegalId>
  <ContractDetails>
    <TxContractDetail>
      <Id>int</Id>
      <Type>string</Type>
      <Size>decimal</Size>
      <UnitOfMeasure>string</UnitOfMeasure>
      <Quantity>decimal</Quantity>
      <Compact>boolean</Compact>
      <CustomerOwn>boolean</CustomerOwn>
      <WeekCode>int</WeekCode>
      <MaxLifts>decimal</MaxLifts>
      <WeekDayFrequency>int</WeekDayFrequency>
      <DemurrageDays>int</DemurrageDays>
      <DemmurageRateDecimal>decimal</DemmurageRateDecimal>
      <PoRquired>boolean</PoRquired>
      <Note1>string</Note1>
      <ScheduledDays>string</ScheduledDays>
      <Service>int</Service>
      <OriginalId>int</OriginalId>
      <Finalized>boolean</Finalized>
      <ReinstateDate>dateTime</ReinstateDate>
      <StopReason>string</StopReason>
      <ChangeReason>string</ChangeReason>
      <Action>int</Action>
      <PriceClass>int</PriceClass>
      <ContractRate>
        <TxContractRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <TxContractRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ContractRate>
      <ContractRateActivityMaterial>
        <TxContractRateActivityMaterial d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <TxContractRateActivityMaterial d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ContractRateActivityMaterial>
    </TxContractDetail>
    <TxContractDetail>
      <Id>int</Id>
      <Type>string</Type>
      <Size>decimal</Size>
      <UnitOfMeasure>string</UnitOfMeasure>
      <Quantity>decimal</Quantity>
      <Compact>boolean</Compact>
      <CustomerOwn>boolean</CustomerOwn>
      <WeekCode>int</WeekCode>
      <MaxLifts>decimal</MaxLifts>
      <WeekDayFrequency>int</WeekDayFrequency>
      <DemurrageDays>int</DemurrageDays>
      <DemmurageRateDecimal>decimal</DemmurageRateDecimal>
      <PoRquired>boolean</PoRquired>
      <Note1>string</Note1>
      <ScheduledDays>string</ScheduledDays>
      <Service>int</Service>
      <OriginalId>int</OriginalId>
      <Finalized>boolean</Finalized>
      <ReinstateDate>dateTime</ReinstateDate>
      <StopReason>string</StopReason>
      <ChangeReason>string</ChangeReason>
      <Action>int</Action>
      <PriceClass>int</PriceClass>
      <ContractRate>
        <TxContractRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <TxContractRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ContractRate>
      <ContractRateActivityMaterial>
        <TxContractRateActivityMaterial d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <TxContractRateActivityMaterial d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ContractRateActivityMaterial>
    </TxContractDetail>
  </ContractDetails>
  <ContractNote>
    <TxContractNote>
      <User>string</User>
      <Note>string</Note>
      <SystemNote>boolean</SystemNote>
    </TxContractNote>
    <TxContractNote>
      <User>string</User>
      <Note>string</Note>
      <SystemNote>boolean</SystemNote>
    </TxContractNote>
  </ContractNote>
  <ContractAttachment>
    <TxContractAttachment>
      <FileName>string</FileName>
      <Note>string</Note>
      <File>base64Binary</File>
      <AttachmentType>int</AttachmentType>
    </TxContractAttachment>
    <TxContractAttachment>
      <FileName>string</FileName>
      <Note>string</Note>
      <File>base64Binary</File>
      <AttachmentType>int</AttachmentType>
    </TxContractAttachment>
  </ContractAttachment>
</TxContract>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /TruxWeb/WSCust_Contract/WS_Contract.asmx/GetContract HTTP/1.1
Host: trux.organicdiversion.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sLoginComp=string&contractId=string&renew=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<TxContract xmlns="http://www.trux.com">
  <Id>int</Id>
  <Number>string</Number>
  <Customer>int</Customer>
  <Site>int</Site>
  <Prospect>int</Prospect>
  <ProspectSite>int</ProspectSite>
  <CreateUser>string</CreateUser>
  <CreationDate>dateTime</CreationDate>
  <SalesRep>int</SalesRep>
  <Status>string</Status>
  <PoNum>string</PoNum>
  <Type>string</Type>
  <Comments>string</Comments>
  <EffectiveDate>dateTime</EffectiveDate>
  <StartDate>dateTime</StartDate>
  <ExpiryDate>dateTime</ExpiryDate>
  <GuaranteeDate>dateTime</GuaranteeDate>
  <CustomerPrintName>string</CustomerPrintName>
  <CustomerTitle>string</CustomerTitle>
  <CustomerSignDate>dateTime</CustomerSignDate>
  <RenewFrom>int</RenewFrom>
  <PrintCopies>int</PrintCopies>
  <ApprovedBy>string</ApprovedBy>
  <ApproveDate>dateTime</ApproveDate>
  <EstimatedRevenue>decimal</EstimatedRevenue>
  <LegalId>int</LegalId>
  <ContractDetails>
    <TxContractDetail>
      <Id>int</Id>
      <Type>string</Type>
      <Size>decimal</Size>
      <UnitOfMeasure>string</UnitOfMeasure>
      <Quantity>decimal</Quantity>
      <Compact>boolean</Compact>
      <CustomerOwn>boolean</CustomerOwn>
      <WeekCode>int</WeekCode>
      <MaxLifts>decimal</MaxLifts>
      <WeekDayFrequency>int</WeekDayFrequency>
      <DemurrageDays>int</DemurrageDays>
      <DemmurageRateDecimal>decimal</DemmurageRateDecimal>
      <PoRquired>boolean</PoRquired>
      <Note1>string</Note1>
      <ScheduledDays>string</ScheduledDays>
      <Service>int</Service>
      <OriginalId>int</OriginalId>
      <Finalized>boolean</Finalized>
      <ReinstateDate>dateTime</ReinstateDate>
      <StopReason>string</StopReason>
      <ChangeReason>string</ChangeReason>
      <Action>int</Action>
      <PriceClass>int</PriceClass>
      <ContractRate>
        <TxContractRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <TxContractRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ContractRate>
      <ContractRateActivityMaterial>
        <TxContractRateActivityMaterial d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <TxContractRateActivityMaterial d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ContractRateActivityMaterial>
    </TxContractDetail>
    <TxContractDetail>
      <Id>int</Id>
      <Type>string</Type>
      <Size>decimal</Size>
      <UnitOfMeasure>string</UnitOfMeasure>
      <Quantity>decimal</Quantity>
      <Compact>boolean</Compact>
      <CustomerOwn>boolean</CustomerOwn>
      <WeekCode>int</WeekCode>
      <MaxLifts>decimal</MaxLifts>
      <WeekDayFrequency>int</WeekDayFrequency>
      <DemurrageDays>int</DemurrageDays>
      <DemmurageRateDecimal>decimal</DemmurageRateDecimal>
      <PoRquired>boolean</PoRquired>
      <Note1>string</Note1>
      <ScheduledDays>string</ScheduledDays>
      <Service>int</Service>
      <OriginalId>int</OriginalId>
      <Finalized>boolean</Finalized>
      <ReinstateDate>dateTime</ReinstateDate>
      <StopReason>string</StopReason>
      <ChangeReason>string</ChangeReason>
      <Action>int</Action>
      <PriceClass>int</PriceClass>
      <ContractRate>
        <TxContractRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <TxContractRate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ContractRate>
      <ContractRateActivityMaterial>
        <TxContractRateActivityMaterial d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <TxContractRateActivityMaterial d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ContractRateActivityMaterial>
    </TxContractDetail>
  </ContractDetails>
  <ContractNote>
    <TxContractNote>
      <User>string</User>
      <Note>string</Note>
      <SystemNote>boolean</SystemNote>
    </TxContractNote>
    <TxContractNote>
      <User>string</User>
      <Note>string</Note>
      <SystemNote>boolean</SystemNote>
    </TxContractNote>
  </ContractNote>
  <ContractAttachment>
    <TxContractAttachment>
      <FileName>string</FileName>
      <Note>string</Note>
      <File>base64Binary</File>
      <AttachmentType>int</AttachmentType>
    </TxContractAttachment>
    <TxContractAttachment>
      <FileName>string</FileName>
      <Note>string</Note>
      <File>base64Binary</File>
      <AttachmentType>int</AttachmentType>
    </TxContractAttachment>
  </ContractAttachment>
</TxContract>

Parameter	Value
sLoginComp:
contractId:
renew: