API Documentation — version 1

Contracts

Sample API URLs

To get all contracts:

https://{your-site}.vendorrisk.com/api/v1/contracts.xml?token={api_key}

XML output:


<contracts>
  <contract>
    [see fields below]
  </contract>
  <contract>
    [see fields below]
  </contract>
</contracts>

To get a specific contract:

https://{your-site}.vendorrisk.com/api/v1/contracts/sample-contract.xml?token={api_key}

XML output:


<contract>
  <vendor>Sample Vendor</vendor>
  <name>Monthly Maintenance Contract</name>
  <user>John Doe</user>
  <contract_status>Active</contract_status>
  <contract_type>Subscription</contract_type>
  <cost>5000</cost>
  <cost_notes></cost_notes>
  <approver1_name>Jane Doe</approver1_name>
  <approver2_name></approver2_name>
  <approver3_name></approver3_name>
  <legal_review></legal_review>
  <start_date>11/30/2009</start_date>
  <termination_date></termination_date>
  <notice_requirement>30 days</notice_requirement>
  <auto_renew>Yes</auto_renew>
  <renewal_interval>1 year</renewal_interval>
  <ins_coverage_type></ins_coverage_type>
  <ins_carrier_limit></ins_carrier_limit>
  <ins_expiration_date></ins_expiration_date>
  <permalink>monthly-maintenance-contract</permalink>
  <created_at>11/30/2009 8:00 PM</created_at>
  <updated_at>11/30/2009 8:00 PM</updated_at>
</contract>