POST api/encompass1/addlicensetouser

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LoginEmail	string	None.
CompanyId	string	None.
OrganizationName	string	None.
NMLSNumber	string	None.
LicenseExtList	Collection of contactLicenseList	None.

Request Formats

application/json, text/json

Sample:

{
  "LoginEmail": "sample string 1",
  "CompanyId": "sample string 2",
  "OrganizationName": "sample string 3",
  "NMLSNumber": "sample string 4",
  "LicenseExtList": [
    {
      "LicenseNumber": "sample string 1",
      "StateCode": "sample string 2",
      "Status": "sample string 3",
      "isActive": true,
      "IssueDate": "2026-11-01T12:14:27.4331685-05:00",
      "StartDate": "2026-11-01T12:14:27.4331685-05:00",
      "EndDate": "2026-11-01T12:14:27.4331685-05:00",
      "StatusDate": "2026-11-01T12:14:27.4331685-05:00"
    },
    {
      "LicenseNumber": "sample string 1",
      "StateCode": "sample string 2",
      "Status": "sample string 3",
      "isActive": true,
      "IssueDate": "2026-11-01T12:14:27.4331685-05:00",
      "StartDate": "2026-11-01T12:14:27.4331685-05:00",
      "EndDate": "2026-11-01T12:14:27.4331685-05:00",
      "StatusDate": "2026-11-01T12:14:27.4331685-05:00"
    }
  ]
}

application/xml, text/xml

Sample:

<LicenseDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NWP.API.Encompass.Models">
  <CompanyId>sample string 2</CompanyId>
  <LicenseExtList>
    <contactLicenseList>
      <EndDate>2026-11-01T12:14:27.4331685-05:00</EndDate>
      <IssueDate>2026-11-01T12:14:27.4331685-05:00</IssueDate>
      <LicenseNumber>sample string 1</LicenseNumber>
      <StartDate>2026-11-01T12:14:27.4331685-05:00</StartDate>
      <StateCode>sample string 2</StateCode>
      <Status>sample string 3</Status>
      <StatusDate>2026-11-01T12:14:27.4331685-05:00</StatusDate>
      <isActive>true</isActive>
    </contactLicenseList>
    <contactLicenseList>
      <EndDate>2026-11-01T12:14:27.4331685-05:00</EndDate>
      <IssueDate>2026-11-01T12:14:27.4331685-05:00</IssueDate>
      <LicenseNumber>sample string 1</LicenseNumber>
      <StartDate>2026-11-01T12:14:27.4331685-05:00</StartDate>
      <StateCode>sample string 2</StateCode>
      <Status>sample string 3</Status>
      <StatusDate>2026-11-01T12:14:27.4331685-05:00</StatusDate>
      <isActive>true</isActive>
    </contactLicenseList>
  </LicenseExtList>
  <LoginEmail>sample string 1</LoginEmail>
  <NMLSNumber>sample string 4</NMLSNumber>
  <OrganizationName>sample string 3</OrganizationName>
</LicenseDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse

Name	Type	Additional 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>