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": "9b036cfb-23fd-4ca4-8575-88c9978fdf63" }
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>9b036cfb-23fd-4ca4-8575-88c9978fdf63</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": "d0470076-c2b1-425d-b46a-aa691947f2c0", "IsAlert": true, "IsFlexAlert": true, "IsServiceAlert": true, "IsAppointment": true, "IsContractEnd": true, "IsMileageAlert": true, "IsWarrantyAlert": true, "IsInMarketAlert": true, "IsEngagedAlert": true, "Rank": 11, "IsCreditConvert": true, "AlertDate": "2024-12-08T00:17:06.665305-08:00", "FlexAlertDate": "2024-12-08T00:17:06.6663004-08:00", "ConversionAlertDate": "2024-12-08T00:17:06.6663004-08:00", "MileageAlertDate": "2024-12-08T00:17:06.6663004-08:00", "WarrantyAlertDate": "2024-12-08T00:17:06.6663004-08:00", "ContractEndDate": "2024-12-08T00:17:06.6663004-08:00", "InMarketDate": "2024-12-08T00:17:06.6663004-08:00", "InMarketEngagedDate": "2024-12-08T00:17:06.6663004-08:00" }, { "EntityID": "d0470076-c2b1-425d-b46a-aa691947f2c0", "IsAlert": true, "IsFlexAlert": true, "IsServiceAlert": true, "IsAppointment": true, "IsContractEnd": true, "IsMileageAlert": true, "IsWarrantyAlert": true, "IsInMarketAlert": true, "IsEngagedAlert": true, "Rank": 11, "IsCreditConvert": true, "AlertDate": "2024-12-08T00:17:06.665305-08:00", "FlexAlertDate": "2024-12-08T00:17:06.6663004-08:00", "ConversionAlertDate": "2024-12-08T00:17:06.6663004-08:00", "MileageAlertDate": "2024-12-08T00:17:06.6663004-08:00", "WarrantyAlertDate": "2024-12-08T00:17:06.6663004-08:00", "ContractEndDate": "2024-12-08T00:17:06.6663004-08:00", "InMarketDate": "2024-12-08T00:17:06.6663004-08:00", "InMarketEngagedDate": "2024-12-08T00:17:06.6663004-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>2024-12-08T00:17:06.665305-08:00</AlertDate> <ContractEndDate>2024-12-08T00:17:06.6663004-08:00</ContractEndDate> <ConversionAlertDate>2024-12-08T00:17:06.6663004-08:00</ConversionAlertDate> <EntityID>d0470076-c2b1-425d-b46a-aa691947f2c0</EntityID> <FlexAlertDate>2024-12-08T00:17:06.6663004-08:00</FlexAlertDate> <InMarketDate>2024-12-08T00:17:06.6663004-08:00</InMarketDate> <InMarketEngagedDate>2024-12-08T00:17:06.6663004-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>2024-12-08T00:17:06.6663004-08:00</MileageAlertDate> <Rank>11</Rank> <WarrantyAlertDate>2024-12-08T00:17:06.6663004-08:00</WarrantyAlertDate> </OpportunityItem> <OpportunityItem> <AlertDate>2024-12-08T00:17:06.665305-08:00</AlertDate> <ContractEndDate>2024-12-08T00:17:06.6663004-08:00</ContractEndDate> <ConversionAlertDate>2024-12-08T00:17:06.6663004-08:00</ConversionAlertDate> <EntityID>d0470076-c2b1-425d-b46a-aa691947f2c0</EntityID> <FlexAlertDate>2024-12-08T00:17:06.6663004-08:00</FlexAlertDate> <InMarketDate>2024-12-08T00:17:06.6663004-08:00</InMarketDate> <InMarketEngagedDate>2024-12-08T00:17:06.6663004-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>2024-12-08T00:17:06.6663004-08:00</MileageAlertDate> <Rank>11</Rank> <WarrantyAlertDate>2024-12-08T00:17:06.6663004-08:00</WarrantyAlertDate> </OpportunityItem> </OpportunityList> </GetOpportunitiesResponse>