Search Memos
GET {{baseUrl}}/memos?primaryStatus=Inactive&secondaryStatus=Sign Change Forced&loadFromDate=1972-06-04&loadToDate=1972-06-04&lastModifiedFromDate=1972-06-04&lastModifiedToDate=1972-06-04&lastCorrespondent=Carrier&lastCorrespondenceFromDate=1972-06-04&lastCorrespondenceToDate=1972-06-04&validatingAirlineDesignator=236&agentNumericCode=83389341&agencyIncludeEntireOrg=false&page=1
By submitting a combination of search parameters, users can retrieve a list of memo numbers and high-level information for each memo. If more than 100 memos fall within the search criteria, the results will be paginated.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
primaryStatus | string | ||
secondaryStatus | string | ||
loadFromDate | string | The beginning date in the Load Date search; format is YYYY-MM-DD | |
loadToDate | string | The ending date in the Load Date search; format is YYYY-MM-DD | |
lastModifiedFromDate | string | The beginning date in the Last Modified Date search; format is YYYY-MM-DD | |
lastModifiedToDate | string | The ending date in the Last Modified Date search; format is YYYY-MM-DD | |
lastCorrespondent | string | ||
lastCorrespondenceFromDate | string | The beginning date in the Last Correspondence Date search; format is YYYY-MM-DD | |
lastCorrespondenceToDate | string | The ending date in the Last Correspondence Date search; format is YYYY-MM-DD | |
validatingAirlineDesignator | number | ||
agentNumericCode | number | ||
agencyIncludeEntireOrg | boolean | Option to include entire agency organization in search; only applicable to Home Offices (HOL) | |
page | number | The search result page to retrieve |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"transactionMetadata":{"correlationId":"5e72c080-6764-11e9-83cb-0028f8be009a","message":"SUCCESS","statusCode":"BAD_REQUEST","timestamp":"2019-04-25T10:14:00.748-04:00"},"transactionResponse":{"totalPages":1,"memos":[{"memoNumber":"8960000001","memoType":"Debit","validatingAirlineDesignator":"100","carrierName":"XYZ AIRLINES","agentNumericCode":"11111111","primaryStatus":"Closed","secondaryStatus":"Settled in IAR","currentBalance":200.5,"age":20,"resolutionType":"Carrier","lastCorrespondent":"Carrier"}]}}