POST Opportunity/getopportunities
Request Information
URI Parameters
None.
Body Parameters
AuthenticatedRequestName | Description | Type | Additional information |
---|---|---|---|
token |
API access token |
globally unique identifier |
Required |
Request Formats
application/json, text/json
Sample:
{ "token": "15ab8427-85ab-4950-a635-b17bcd615996" }
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>15ab8427-85ab-4950-a635-b17bcd615996</token> </AuthenticatedRequest>
Response Information
Resource Description
GetOpportunitiesResponseName | Description | Type | Additional 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": "25d54d55-3705-4db4-99cf-40e6375a1962", "IsAlert": true, "IsFlexAlert": true, "IsServiceAlert": true, "IsAppointment": true, "IsContractEnd": true, "IsMileageAlert": true, "IsWarrantyAlert": true, "IsInMarketAlert": true, "IsEngagedAlert": true, "Rank": 11, "IsCreditConvert": true, "AlertDate": "2025-05-23T09:44:40.8241686-07:00", "FlexAlertDate": "2025-05-23T09:44:40.8241686-07:00", "ConversionAlertDate": "2025-05-23T09:44:40.8241686-07:00", "MileageAlertDate": "2025-05-23T09:44:40.8241686-07:00", "WarrantyAlertDate": "2025-05-23T09:44:40.8241686-07:00", "ContractEndDate": "2025-05-23T09:44:40.8251602-07:00", "InMarketDate": "2025-05-23T09:44:40.8251602-07:00", "InMarketEngagedDate": "2025-05-23T09:44:40.8251602-07:00" }, { "EntityID": "25d54d55-3705-4db4-99cf-40e6375a1962", "IsAlert": true, "IsFlexAlert": true, "IsServiceAlert": true, "IsAppointment": true, "IsContractEnd": true, "IsMileageAlert": true, "IsWarrantyAlert": true, "IsInMarketAlert": true, "IsEngagedAlert": true, "Rank": 11, "IsCreditConvert": true, "AlertDate": "2025-05-23T09:44:40.8241686-07:00", "FlexAlertDate": "2025-05-23T09:44:40.8241686-07:00", "ConversionAlertDate": "2025-05-23T09:44:40.8241686-07:00", "MileageAlertDate": "2025-05-23T09:44:40.8241686-07:00", "WarrantyAlertDate": "2025-05-23T09:44:40.8241686-07:00", "ContractEndDate": "2025-05-23T09:44:40.8251602-07:00", "InMarketDate": "2025-05-23T09:44:40.8251602-07:00", "InMarketEngagedDate": "2025-05-23T09:44:40.8251602-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>2025-05-23T09:44:40.8241686-07:00</AlertDate> <ContractEndDate>2025-05-23T09:44:40.8251602-07:00</ContractEndDate> <ConversionAlertDate>2025-05-23T09:44:40.8241686-07:00</ConversionAlertDate> <EntityID>25d54d55-3705-4db4-99cf-40e6375a1962</EntityID> <FlexAlertDate>2025-05-23T09:44:40.8241686-07:00</FlexAlertDate> <InMarketDate>2025-05-23T09:44:40.8251602-07:00</InMarketDate> <InMarketEngagedDate>2025-05-23T09:44:40.8251602-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>2025-05-23T09:44:40.8241686-07:00</MileageAlertDate> <Rank>11</Rank> <WarrantyAlertDate>2025-05-23T09:44:40.8241686-07:00</WarrantyAlertDate> </OpportunityItem> <OpportunityItem> <AlertDate>2025-05-23T09:44:40.8241686-07:00</AlertDate> <ContractEndDate>2025-05-23T09:44:40.8251602-07:00</ContractEndDate> <ConversionAlertDate>2025-05-23T09:44:40.8241686-07:00</ConversionAlertDate> <EntityID>25d54d55-3705-4db4-99cf-40e6375a1962</EntityID> <FlexAlertDate>2025-05-23T09:44:40.8241686-07:00</FlexAlertDate> <InMarketDate>2025-05-23T09:44:40.8251602-07:00</InMarketDate> <InMarketEngagedDate>2025-05-23T09:44:40.8251602-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>2025-05-23T09:44:40.8241686-07:00</MileageAlertDate> <Rank>11</Rank> <WarrantyAlertDate>2025-05-23T09:44:40.8241686-07:00</WarrantyAlertDate> </OpportunityItem> </OpportunityList> </GetOpportunitiesResponse>