POST api/encompass/addlicencetocompany

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OId	integer	None.
OrganizationName	string	None.
NMLSNumber	string	None.
CompanyId	string	None.
StateLicenseExtList	Collection of StateLicenseExt	None.

Request Formats

application/json, text/json

Sample:

{
  "OId": 1,
  "OrganizationName": "sample string 2",
  "NMLSNumber": "sample string 3",
  "CompanyId": "sample string 4",
  "StateLicenseExtList": [
    {
      "LicenseStatus": "sample string 1",
      "LicenseNo": "sample string 2",
      "LicenseType": "sample string 3",
      "IssueDate": "2026-11-01T12:14:27.2456656-05:00",
      "StatusDate": "2026-11-01T12:14:27.2456656-05:00",
      "Active": true,
      "StateCode": "sample string 7",
      "StartDate": "2026-11-01T12:14:27.2456656-05:00",
      "EndDate": "2026-11-01T12:14:27.2456656-05:00",
      "Approved": true,
      "Exempt": true,
      "LastChecked": "2026-11-01T12:14:27.2456656-05:00"
    },
    {
      "LicenseStatus": "sample string 1",
      "LicenseNo": "sample string 2",
      "LicenseType": "sample string 3",
      "IssueDate": "2026-11-01T12:14:27.2456656-05:00",
      "StatusDate": "2026-11-01T12:14:27.2456656-05:00",
      "Active": true,
      "StateCode": "sample string 7",
      "StartDate": "2026-11-01T12:14:27.2456656-05:00",
      "EndDate": "2026-11-01T12:14:27.2456656-05:00",
      "Approved": true,
      "Exempt": true,
      "LastChecked": "2026-11-01T12:14:27.2456656-05:00"
    }
  ]
}

application/xml, text/xml

Sample:

<StateLicenceModel 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>
  <StateLicenseExtList xmlns:d2p1="http://schemas.datacontract.org/2004/07/FX.TPO.ExternalCompanySetup">
    <d2p1:StateLicenseExt>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Approved>true</d2p1:Approved>
      <d2p1:EndDate>2026-11-01T12:14:27.2456656-05:00</d2p1:EndDate>
      <d2p1:Exempt>true</d2p1:Exempt>
      <d2p1:IssueDate>2026-11-01T12:14:27.2456656-05:00</d2p1:IssueDate>
      <d2p1:LastChecked>2026-11-01T12:14:27.2456656-05:00</d2p1:LastChecked>
      <d2p1:LicenseNo>sample string 2</d2p1:LicenseNo>
      <d2p1:LicenseStatus>sample string 1</d2p1:LicenseStatus>
      <d2p1:LicenseType>sample string 3</d2p1:LicenseType>
      <d2p1:StartDate>2026-11-01T12:14:27.2456656-05:00</d2p1:StartDate>
      <d2p1:StateCode>sample string 7</d2p1:StateCode>
      <d2p1:StatusDate>2026-11-01T12:14:27.2456656-05:00</d2p1:StatusDate>
    </d2p1:StateLicenseExt>
    <d2p1:StateLicenseExt>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Approved>true</d2p1:Approved>
      <d2p1:EndDate>2026-11-01T12:14:27.2456656-05:00</d2p1:EndDate>
      <d2p1:Exempt>true</d2p1:Exempt>
      <d2p1:IssueDate>2026-11-01T12:14:27.2456656-05:00</d2p1:IssueDate>
      <d2p1:LastChecked>2026-11-01T12:14:27.2456656-05:00</d2p1:LastChecked>
      <d2p1:LicenseNo>sample string 2</d2p1:LicenseNo>
      <d2p1:LicenseStatus>sample string 1</d2p1:LicenseStatus>
      <d2p1:LicenseType>sample string 3</d2p1:LicenseType>
      <d2p1:StartDate>2026-11-01T12:14:27.2456656-05:00</d2p1:StartDate>
      <d2p1:StateCode>sample string 7</d2p1:StateCode>
      <d2p1:StatusDate>2026-11-01T12:14:27.2456656-05:00</d2p1:StatusDate>
    </d2p1:StateLicenseExt>
  </StateLicenseExtList>
</StateLicenceModel>

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>