POST api/encompass/managetpocontact

Request Information

URI Parameters

None.

Body Parameters

ContactModel
NameDescriptionTypeAdditional information
OId

integer

None.

OrganizationName

string

None.

NMLSNumber

string

None.

contactLists

Collection of ContactList

None.

CompanyId

string

None.

response

ApiResponses

None.

Request Formats

application/json, text/json

Sample:
{
  "OId": 1,
  "OrganizationName": "sample string 2",
  "NMLSNumber": "sample string 3",
  "contactLists": [
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "LoginEmail": "sample string 3",
      "Password": "sample string 4",
      "PrimarySalesRepId": "sample string 5",
      "Persona": "sample string 6",
      "Address": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "Zipcode": "sample string 10",
      "MobilePhone": "sample string 11",
      "CellPhone": "sample string 12",
      "NMLSNumber": "sample string 13",
      "Notes": "sample string 14"
    },
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "LoginEmail": "sample string 3",
      "Password": "sample string 4",
      "PrimarySalesRepId": "sample string 5",
      "Persona": "sample string 6",
      "Address": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "Zipcode": "sample string 10",
      "MobilePhone": "sample string 11",
      "CellPhone": "sample string 12",
      "NMLSNumber": "sample string 13",
      "Notes": "sample string 14"
    }
  ],
  "CompanyId": "sample string 4",
  "response": {
    "response": {},
    "status": "sample string 2",
    "errormessage": "sample string 3",
    "data": {}
  }
}

application/xml, text/xml

Sample:
<ContactModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NWP.API.Encompass.Models">
  <CompanyId>sample string 4</CompanyId>
  <NMLSNumber>sample string 3</NMLSNumber>
  <OId>1</OId>
  <OrganizationName>sample string 2</OrganizationName>
  <contactLists>
    <ContactList>
      <Address>sample string 7</Address>
      <CellPhone>sample string 12</CellPhone>
      <City>sample string 8</City>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <LoginEmail>sample string 3</LoginEmail>
      <MobilePhone>sample string 11</MobilePhone>
      <NMLSNumber>sample string 13</NMLSNumber>
      <Notes>sample string 14</Notes>
      <Password>sample string 4</Password>
      <Persona>sample string 6</Persona>
      <PrimarySalesRepId>sample string 5</PrimarySalesRepId>
      <State>sample string 9</State>
      <Zipcode>sample string 10</Zipcode>
    </ContactList>
    <ContactList>
      <Address>sample string 7</Address>
      <CellPhone>sample string 12</CellPhone>
      <City>sample string 8</City>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <LoginEmail>sample string 3</LoginEmail>
      <MobilePhone>sample string 11</MobilePhone>
      <NMLSNumber>sample string 13</NMLSNumber>
      <Notes>sample string 14</Notes>
      <Password>sample string 4</Password>
      <Persona>sample string 6</Persona>
      <PrimarySalesRepId>sample string 5</PrimarySalesRepId>
      <State>sample string 9</State>
      <Zipcode>sample string 10</Zipcode>
    </ContactList>
  </contactLists>
  <response>
    <data />
    <errormessage>sample string 3</errormessage>
    <status>sample string 2</status>
    <response />
  </response>
</ContactModel>

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>