POST Opportunity/getopportunities

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
token		globally unique identifier	Required

Request Formats

application/json, text/json

Sample:

{
  "token": "7e12509e-9da2-4e51-986d-c2cffb4d7536"
}

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>7e12509e-9da2-4e51-986d-c2cffb4d7536</token>
</AuthenticatedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetOpportunitiesResponse

Name	Type	Additional information
code	integer	None.
error	string	None.
OpportunityList	Collection of OpportunityItem	None.
APIVersion	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OpportunityList": [
    {
      "EntityID": "7bcc840b-5c33-4a69-abef-769a436f6d5c",
      "IsAlert": true,
      "IsFlexAlert": true,
      "IsServiceAlert": true,
      "IsAppointment": true,
      "IsContractEnd": true,
      "IsMileageAlert": true,
      "IsWarrantyAlert": true,
      "IsInMarketAlert": true,
      "IsEngagedAlert": true,
      "Rank": 11,
      "IsCreditConvert": true,
      "AlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "FlexAlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "ConversionAlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "MileageAlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "WarrantyAlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "ContractEndDate": "2026-02-20T13:01:07.6826591-08:00",
      "InMarketDate": "2026-02-20T13:01:07.6826591-08:00",
      "InMarketEngagedDate": "2026-02-20T13:01:07.6826591-08:00"
    },
    {
      "EntityID": "7bcc840b-5c33-4a69-abef-769a436f6d5c",
      "IsAlert": true,
      "IsFlexAlert": true,
      "IsServiceAlert": true,
      "IsAppointment": true,
      "IsContractEnd": true,
      "IsMileageAlert": true,
      "IsWarrantyAlert": true,
      "IsInMarketAlert": true,
      "IsEngagedAlert": true,
      "Rank": 11,
      "IsCreditConvert": true,
      "AlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "FlexAlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "ConversionAlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "MileageAlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "WarrantyAlertDate": "2026-02-20T13:01:07.6826591-08:00",
      "ContractEndDate": "2026-02-20T13:01:07.6826591-08:00",
      "InMarketDate": "2026-02-20T13:01:07.6826591-08:00",
      "InMarketEngagedDate": "2026-02-20T13:01:07.6826591-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>2026-02-20T13:01:07.6826591-08:00</AlertDate>
      <ContractEndDate>2026-02-20T13:01:07.6826591-08:00</ContractEndDate>
      <ConversionAlertDate>2026-02-20T13:01:07.6826591-08:00</ConversionAlertDate>
      <EntityID>7bcc840b-5c33-4a69-abef-769a436f6d5c</EntityID>
      <FlexAlertDate>2026-02-20T13:01:07.6826591-08:00</FlexAlertDate>
      <InMarketDate>2026-02-20T13:01:07.6826591-08:00</InMarketDate>
      <InMarketEngagedDate>2026-02-20T13:01:07.6826591-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>2026-02-20T13:01:07.6826591-08:00</MileageAlertDate>
      <Rank>11</Rank>
      <WarrantyAlertDate>2026-02-20T13:01:07.6826591-08:00</WarrantyAlertDate>
    </OpportunityItem>
    <OpportunityItem>
      <AlertDate>2026-02-20T13:01:07.6826591-08:00</AlertDate>
      <ContractEndDate>2026-02-20T13:01:07.6826591-08:00</ContractEndDate>
      <ConversionAlertDate>2026-02-20T13:01:07.6826591-08:00</ConversionAlertDate>
      <EntityID>7bcc840b-5c33-4a69-abef-769a436f6d5c</EntityID>
      <FlexAlertDate>2026-02-20T13:01:07.6826591-08:00</FlexAlertDate>
      <InMarketDate>2026-02-20T13:01:07.6826591-08:00</InMarketDate>
      <InMarketEngagedDate>2026-02-20T13:01:07.6826591-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>2026-02-20T13:01:07.6826591-08:00</MileageAlertDate>
      <Rank>11</Rank>
      <WarrantyAlertDate>2026-02-20T13:01:07.6826591-08:00</WarrantyAlertDate>
    </OpportunityItem>
  </OpportunityList>
</GetOpportunitiesResponse>