POST Opportunity/getopportunities

Request Information

URI Parameters

None.

Body Parameters

AuthenticatedRequest
NameDescriptionTypeAdditional information
token

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "token": "1e05a189-0e2f-4988-86d6-3fb12ffbf005"
}

application/xml, text/xml

Sample:
<AuthenticatedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">
  <token>1e05a189-0e2f-4988-86d6-3fb12ffbf005</token>
</AuthenticatedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetOpportunitiesResponse
NameDescriptionTypeAdditional information
code

integer

None.

error

string

None.

OpportunityList

Collection of OpportunityItem

None.

APIVersion

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "OpportunityList": [
    {
      "EntityID": "80ac4606-eddf-4d17-ac3e-a451286cdd61",
      "IsAlert": true,
      "IsFlexAlert": true,
      "IsServiceAlert": true,
      "IsAppointment": true,
      "IsContractEnd": true,
      "IsMileageAlert": true,
      "IsWarrantyAlert": true,
      "IsInMarketAlert": true,
      "IsEngagedAlert": true,
      "Rank": 11,
      "IsCreditConvert": true,
      "AlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "FlexAlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "ConversionAlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "MileageAlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "WarrantyAlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "ContractEndDate": "2025-12-19T02:19:49.5310654-08:00",
      "InMarketDate": "2025-12-19T02:19:49.5310654-08:00",
      "InMarketEngagedDate": "2025-12-19T02:19:49.5310654-08:00"
    },
    {
      "EntityID": "80ac4606-eddf-4d17-ac3e-a451286cdd61",
      "IsAlert": true,
      "IsFlexAlert": true,
      "IsServiceAlert": true,
      "IsAppointment": true,
      "IsContractEnd": true,
      "IsMileageAlert": true,
      "IsWarrantyAlert": true,
      "IsInMarketAlert": true,
      "IsEngagedAlert": true,
      "Rank": 11,
      "IsCreditConvert": true,
      "AlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "FlexAlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "ConversionAlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "MileageAlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "WarrantyAlertDate": "2025-12-19T02:19:49.5310654-08:00",
      "ContractEndDate": "2025-12-19T02:19:49.5310654-08:00",
      "InMarketDate": "2025-12-19T02:19:49.5310654-08:00",
      "InMarketEngagedDate": "2025-12-19T02:19:49.5310654-08:00"
    }
  ],
  "APIVersion": 1,
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:
<GetOpportunitiesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Opportunity">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
  <OpportunityList>
    <OpportunityItem>
      <AlertDate>2025-12-19T02:19:49.5310654-08:00</AlertDate>
      <ContractEndDate>2025-12-19T02:19:49.5310654-08:00</ContractEndDate>
      <ConversionAlertDate>2025-12-19T02:19:49.5310654-08:00</ConversionAlertDate>
      <EntityID>80ac4606-eddf-4d17-ac3e-a451286cdd61</EntityID>
      <FlexAlertDate>2025-12-19T02:19:49.5310654-08:00</FlexAlertDate>
      <InMarketDate>2025-12-19T02:19:49.5310654-08:00</InMarketDate>
      <InMarketEngagedDate>2025-12-19T02:19:49.5310654-08:00</InMarketEngagedDate>
      <IsAlert>true</IsAlert>
      <IsAppointment>true</IsAppointment>
      <IsContractEnd>true</IsContractEnd>
      <IsCreditConvert>true</IsCreditConvert>
      <IsEngagedAlert>true</IsEngagedAlert>
      <IsFlexAlert>true</IsFlexAlert>
      <IsInMarketAlert>true</IsInMarketAlert>
      <IsMileageAlert>true</IsMileageAlert>
      <IsServiceAlert>true</IsServiceAlert>
      <IsWarrantyAlert>true</IsWarrantyAlert>
      <MileageAlertDate>2025-12-19T02:19:49.5310654-08:00</MileageAlertDate>
      <Rank>11</Rank>
      <WarrantyAlertDate>2025-12-19T02:19:49.5310654-08:00</WarrantyAlertDate>
    </OpportunityItem>
    <OpportunityItem>
      <AlertDate>2025-12-19T02:19:49.5310654-08:00</AlertDate>
      <ContractEndDate>2025-12-19T02:19:49.5310654-08:00</ContractEndDate>
      <ConversionAlertDate>2025-12-19T02:19:49.5310654-08:00</ConversionAlertDate>
      <EntityID>80ac4606-eddf-4d17-ac3e-a451286cdd61</EntityID>
      <FlexAlertDate>2025-12-19T02:19:49.5310654-08:00</FlexAlertDate>
      <InMarketDate>2025-12-19T02:19:49.5310654-08:00</InMarketDate>
      <InMarketEngagedDate>2025-12-19T02:19:49.5310654-08:00</InMarketEngagedDate>
      <IsAlert>true</IsAlert>
      <IsAppointment>true</IsAppointment>
      <IsContractEnd>true</IsContractEnd>
      <IsCreditConvert>true</IsCreditConvert>
      <IsEngagedAlert>true</IsEngagedAlert>
      <IsFlexAlert>true</IsFlexAlert>
      <IsInMarketAlert>true</IsInMarketAlert>
      <IsMileageAlert>true</IsMileageAlert>
      <IsServiceAlert>true</IsServiceAlert>
      <IsWarrantyAlert>true</IsWarrantyAlert>
      <MileageAlertDate>2025-12-19T02:19:49.5310654-08:00</MileageAlertDate>
      <Rank>11</Rank>
      <WarrantyAlertDate>2025-12-19T02:19:49.5310654-08:00</WarrantyAlertDate>
    </OpportunityItem>
  </OpportunityList>
</GetOpportunitiesResponse>