POST Opportunity/getopportunities

Request Information

URI Parameters

None.

Body Parameters

AuthenticatedRequest
NameDescriptionTypeAdditional information
token

API access token

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "token": "57114c64-583f-401c-95e1-e3ef5c330571"
}

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>57114c64-583f-401c-95e1-e3ef5c330571</token>
</AuthenticatedRequest>

Response Information

Resource Description

GetOpportunitiesResponse
NameDescriptionTypeAdditional information
code

API result code

integer

None.

error

API error message

string

None.

OpportunityList

Opportunity list

Collection of OpportunityItem

None.

APIVersion

API Version

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "OpportunityList": [
    {
      "EntityID": "838d22ef-6b0d-4c23-b88e-ddbe325f2fac",
      "IsAlert": true,
      "IsFlexAlert": true,
      "IsServiceAlert": true,
      "IsAppointment": true,
      "IsContractEnd": true,
      "IsMileageAlert": true,
      "IsWarrantyAlert": true,
      "IsInMarketAlert": true,
      "IsEngagedAlert": true,
      "Rank": 11,
      "IsCreditConvert": true,
      "AlertDate": "2024-07-16T04:25:55.333294-07:00",
      "FlexAlertDate": "2024-07-16T04:25:55.333294-07:00",
      "ConversionAlertDate": "2024-07-16T04:25:55.333294-07:00",
      "MileageAlertDate": "2024-07-16T04:25:55.333294-07:00",
      "WarrantyAlertDate": "2024-07-16T04:25:55.333294-07:00",
      "ContractEndDate": "2024-07-16T04:25:55.333294-07:00",
      "InMarketDate": "2024-07-16T04:25:55.333294-07:00",
      "InMarketEngagedDate": "2024-07-16T04:25:55.333294-07:00"
    },
    {
      "EntityID": "838d22ef-6b0d-4c23-b88e-ddbe325f2fac",
      "IsAlert": true,
      "IsFlexAlert": true,
      "IsServiceAlert": true,
      "IsAppointment": true,
      "IsContractEnd": true,
      "IsMileageAlert": true,
      "IsWarrantyAlert": true,
      "IsInMarketAlert": true,
      "IsEngagedAlert": true,
      "Rank": 11,
      "IsCreditConvert": true,
      "AlertDate": "2024-07-16T04:25:55.333294-07:00",
      "FlexAlertDate": "2024-07-16T04:25:55.333294-07:00",
      "ConversionAlertDate": "2024-07-16T04:25:55.333294-07:00",
      "MileageAlertDate": "2024-07-16T04:25:55.333294-07:00",
      "WarrantyAlertDate": "2024-07-16T04:25:55.333294-07:00",
      "ContractEndDate": "2024-07-16T04:25:55.333294-07:00",
      "InMarketDate": "2024-07-16T04:25:55.333294-07:00",
      "InMarketEngagedDate": "2024-07-16T04:25:55.333294-07: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>2024-07-16T04:25:55.333294-07:00</AlertDate>
      <ContractEndDate>2024-07-16T04:25:55.333294-07:00</ContractEndDate>
      <ConversionAlertDate>2024-07-16T04:25:55.333294-07:00</ConversionAlertDate>
      <EntityID>838d22ef-6b0d-4c23-b88e-ddbe325f2fac</EntityID>
      <FlexAlertDate>2024-07-16T04:25:55.333294-07:00</FlexAlertDate>
      <InMarketDate>2024-07-16T04:25:55.333294-07:00</InMarketDate>
      <InMarketEngagedDate>2024-07-16T04:25:55.333294-07: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>2024-07-16T04:25:55.333294-07:00</MileageAlertDate>
      <Rank>11</Rank>
      <WarrantyAlertDate>2024-07-16T04:25:55.333294-07:00</WarrantyAlertDate>
    </OpportunityItem>
    <OpportunityItem>
      <AlertDate>2024-07-16T04:25:55.333294-07:00</AlertDate>
      <ContractEndDate>2024-07-16T04:25:55.333294-07:00</ContractEndDate>
      <ConversionAlertDate>2024-07-16T04:25:55.333294-07:00</ConversionAlertDate>
      <EntityID>838d22ef-6b0d-4c23-b88e-ddbe325f2fac</EntityID>
      <FlexAlertDate>2024-07-16T04:25:55.333294-07:00</FlexAlertDate>
      <InMarketDate>2024-07-16T04:25:55.333294-07:00</InMarketDate>
      <InMarketEngagedDate>2024-07-16T04:25:55.333294-07: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>2024-07-16T04:25:55.333294-07:00</MileageAlertDate>
      <Rank>11</Rank>
      <WarrantyAlertDate>2024-07-16T04:25:55.333294-07:00</WarrantyAlertDate>
    </OpportunityItem>
  </OpportunityList>
</GetOpportunitiesResponse>