POST api/encompass/getcompanybynmlsnumber

Request Information

URI Parameters

None.

Body Parameters

CompanyModel
NameDescriptionTypeAdditional information
OrganizationName

string

None.

Phone

string

None.

Fax

string

None.

WebSite

string

None.

AddressLine1

string

None.

AddressLine2

string

None.

City

string

None.

State

string

None.

NMLSNumber

string

None.

Zip

string

None.

Email

string

None.

DateOfIncorporation

string

None.

TypeOfEntity

string

None.

CompanyId

string

None.

response

ApiResponses

None.

Request Formats

application/json, text/json

Sample:
{
  "OrganizationName": "sample string 1",
  "Phone": "sample string 2",
  "Fax": "sample string 3",
  "WebSite": "sample string 4",
  "AddressLine1": "sample string 5",
  "AddressLine2": "sample string 6",
  "City": "sample string 7",
  "State": "sample string 8",
  "NMLSNumber": "sample string 9",
  "Zip": "sample string 10",
  "Email": "sample string 11",
  "DateOfIncorporation": "sample string 12",
  "TypeOfEntity": "sample string 13",
  "CompanyId": "sample string 14",
  "response": {
    "response": {},
    "status": "sample string 2",
    "errormessage": "sample string 3",
    "data": {}
  }
}

application/xml, text/xml

Sample:
<CompanyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NWP.API.Encompass.Models">
  <AddressLine1>sample string 5</AddressLine1>
  <AddressLine2>sample string 6</AddressLine2>
  <City>sample string 7</City>
  <CompanyId>sample string 14</CompanyId>
  <DateOfIncorporation>sample string 12</DateOfIncorporation>
  <Email>sample string 11</Email>
  <Fax>sample string 3</Fax>
  <NMLSNumber>sample string 9</NMLSNumber>
  <OrganizationName>sample string 1</OrganizationName>
  <Phone>sample string 2</Phone>
  <State>sample string 8</State>
  <TypeOfEntity>sample string 13</TypeOfEntity>
  <WebSite>sample string 4</WebSite>
  <Zip>sample string 10</Zip>
  <response>
    <data />
    <errormessage>sample string 3</errormessage>
    <status>sample string 2</status>
    <response />
  </response>
</CompanyModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
response

ModelBase

None.

status

string

None.

errormessage

string

None.

data

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "response": null,
  "status": "sample string 1",
  "errormessage": "sample string 2",
  "data": {}
}

application/xml, text/xml

Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NWP.API.Encompass.Models">
  <data />
  <errormessage>sample string 2</errormessage>
  <status>sample string 1</status>
  <response i:nil="true" />
</ApiResponse>