POST api/customer/application/search

Searches for applications

Request Information

URI Parameters

None.

Body Parameters

ERP.Api.Models.CustomerPortal.PortalApplicationSearchModel

Name	Description	Type	Additional information
DateRange	Gets or sets the date range.	ERP.Api.Models.CustomerPortal.SearchDateRange	None.
PortalStatusLabel	Gets or sets the portal status label.	string	None.
OwnerId	Gets or sets the owner id. If not supplied, the default self-service queue owner id is used.	integer	None.
ContactId	Gets or sets the contact id.	integer	None.
ContactName	Gets or sets the contact name.	string	None.
Registration	Gets or sets the vehicle registration.	string	None.
PageSize	Gets or sets the page size.	integer	None.
PageNumber	Gets or sets the page number.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "dateRange": "LastSevenDays",
  "portalStatusLabel": "sample string 1",
  "ownerId": 1,
  "contactId": 1,
  "contactName": "sample string 2",
  "registration": "sample string 3",
  "pageSize": 1,
  "pageNumber": 1
}

application/xml, text/xml

Sample:

<PortalApplicationSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models.CustomerPortal">
  <ContactId>1</ContactId>
  <ContactName>sample string 2</ContactName>
  <DateRange>LastSevenDays</DateRange>
  <OwnerId>1</OwnerId>
  <PageNumber>1</PageNumber>
  <PageSize>1</PageSize>
  <PortalStatusLabel>sample string 1</PortalStatusLabel>
  <Registration>sample string 3</Registration>
</PortalApplicationSearchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'ERP.Api.Models.CustomerPortal.PortalApplicationSearchModel'.

Response Information

Resource Description

ERP.Domain.CRM.Application.ApplicationSearchResponse

Name	Type	Additional information
PageResults	Collection of ERP.Domain.CRM.Application.ApplicationSummary	None.
PageSize	integer	None.
PageNumber	integer	None.
TotalRecords	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "pageResults": [
    {
      "portalStatusLabel": "sample string 1",
      "opened": "2025-01-19",
      "modified": "2025-01-19",
      "risk": 0,
      "mainApplicant": {
        "id": 1,
        "title": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4"
      },
      "source": {
        "id": 1,
        "name": "sample string 2",
        "idString": "sample string 3",
        "type": {
          "id": 1,
          "label": "sample string 2"
        }
      },
      "owner": {
        "id": 1,
        "userName": "sample string 2",
        "role": "None",
        "level": "None"
      },
      "lender": {
        "id": 1,
        "name": "sample string 2",
        "shortName": "sample string 3"
      },
      "vehicle": {
        "id": 1,
        "make": "sample string 2",
        "model": "sample string 3",
        "registration": "sample string 4"
      }
    },
    {
      "portalStatusLabel": "sample string 1",
      "opened": "2025-01-19",
      "modified": "2025-01-19",
      "risk": 0,
      "mainApplicant": {
        "id": 1,
        "title": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4"
      },
      "source": {
        "id": 1,
        "name": "sample string 2",
        "idString": "sample string 3",
        "type": {
          "id": 1,
          "label": "sample string 2"
        }
      },
      "owner": {
        "id": 1,
        "userName": "sample string 2",
        "role": "None",
        "level": "None"
      },
      "lender": {
        "id": 1,
        "name": "sample string 2",
        "shortName": "sample string 3"
      },
      "vehicle": {
        "id": 1,
        "make": "sample string 2",
        "model": "sample string 3",
        "registration": "sample string 4"
      }
    }
  ],
  "pageSize": 1,
  "pageNumber": 2,
  "totalRecords": 3
}

application/xml, text/xml

Sample:

<ApplicationSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Domain.CRM.Application">
  <PageNumber>2</PageNumber>
  <PageResults>
    <ApplicationSummary>
      <Lender>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <ShortName>sample string 3</ShortName>
      </Lender>
      <MainApplicant>
        <FirstName>sample string 3</FirstName>
        <Id>1</Id>
        <LastName>sample string 4</LastName>
        <Title>sample string 2</Title>
      </MainApplicant>
      <Modified>2025-01-19T00:20:27.6672064+00:00</Modified>
      <Opened>2025-01-19T00:20:27.6672064+00:00</Opened>
      <Owner>
        <Id>1</Id>
        <Level>None</Level>
        <Role>None</Role>
        <UserName>sample string 2</UserName>
      </Owner>
      <PortalStatusLabel>sample string 1</PortalStatusLabel>
      <Risk>NotPresent</Risk>
      <Source>
        <Id>1</Id>
        <IdString>sample string 3</IdString>
        <Name>sample string 2</Name>
        <Type>
          <Id>1</Id>
          <Label>sample string 2</Label>
        </Type>
      </Source>
      <StatusCode>EnquiryReceived</StatusCode>
      <Vehicle>
        <Id>1</Id>
        <Make>sample string 2</Make>
        <Model>sample string 3</Model>
        <Registration>sample string 4</Registration>
      </Vehicle>
    </ApplicationSummary>
    <ApplicationSummary>
      <Lender>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <ShortName>sample string 3</ShortName>
      </Lender>
      <MainApplicant>
        <FirstName>sample string 3</FirstName>
        <Id>1</Id>
        <LastName>sample string 4</LastName>
        <Title>sample string 2</Title>
      </MainApplicant>
      <Modified>2025-01-19T00:20:27.6672064+00:00</Modified>
      <Opened>2025-01-19T00:20:27.6672064+00:00</Opened>
      <Owner>
        <Id>1</Id>
        <Level>None</Level>
        <Role>None</Role>
        <UserName>sample string 2</UserName>
      </Owner>
      <PortalStatusLabel>sample string 1</PortalStatusLabel>
      <Risk>NotPresent</Risk>
      <Source>
        <Id>1</Id>
        <IdString>sample string 3</IdString>
        <Name>sample string 2</Name>
        <Type>
          <Id>1</Id>
          <Label>sample string 2</Label>
        </Type>
      </Source>
      <StatusCode>EnquiryReceived</StatusCode>
      <Vehicle>
        <Id>1</Id>
        <Make>sample string 2</Make>
        <Model>sample string 3</Model>
        <Registration>sample string 4</Registration>
      </Vehicle>
    </ApplicationSummary>
  </PageResults>
  <PageSize>1</PageSize>
  <TotalRecords>3</TotalRecords>
</ApplicationSearchResponse>