GET v1/provider/entities?UserId={UserId}&includePending={includePending}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | string |
None. |
|
| includePending | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
ApiResponseNewOfListOfBusinessEntityDto| Name | Description | Type | Additional information |
|---|---|---|---|
| status | integer |
None. |
|
| message | string |
None. |
|
| data | Collection of BusinessEntityDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"status": 1,
"message": "sample string 2",
"data": [
{
"providerId": "f98a6afc-823c-4237-a9ae-c6861bffcf39",
"managerName": "sample string 1",
"businessName": "sample string 2",
"divisionId": "sample string 3",
"divisionName": "sample string 4",
"divisionImage": "sample string 5",
"managerEmail": "sample string 6",
"formationDate": "sample string 7",
"ein": "sample string 8",
"isHead": true,
"managerMobile": "sample string 9",
"address1": "sample string 10",
"address2": "sample string 11",
"city": "sample string 12",
"state": "sample string 13",
"zip": "sample string 14",
"providerUniqueCode": "sample string 15",
"status": "sample string 16",
"statusVideoUrl": "sample string 17",
"stage": "sample string 18",
"stageDescription": "sample string 19",
"mobileAppOrder": 20,
"renewalsCount": 21,
"providerOperatorsCredentialRenewalsCount": 22,
"logo": "sample string 24"
},
{
"providerId": "f98a6afc-823c-4237-a9ae-c6861bffcf39",
"managerName": "sample string 1",
"businessName": "sample string 2",
"divisionId": "sample string 3",
"divisionName": "sample string 4",
"divisionImage": "sample string 5",
"managerEmail": "sample string 6",
"formationDate": "sample string 7",
"ein": "sample string 8",
"isHead": true,
"managerMobile": "sample string 9",
"address1": "sample string 10",
"address2": "sample string 11",
"city": "sample string 12",
"state": "sample string 13",
"zip": "sample string 14",
"providerUniqueCode": "sample string 15",
"status": "sample string 16",
"statusVideoUrl": "sample string 17",
"stage": "sample string 18",
"stageDescription": "sample string 19",
"mobileAppOrder": 20,
"renewalsCount": 21,
"providerOperatorsCredentialRenewalsCount": 22,
"logo": "sample string 24"
}
]
}
application/xml, text/xml
Sample:
<ApiResponseNewOfArrayOfBusinessEntityDtoqfWPY2Au xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OrionDAL.ApiModels.Version1">
<data>
<BusinessEntityDto>
<Address1>sample string 10</Address1>
<Address2>sample string 11</Address2>
<BusinessName>sample string 2</BusinessName>
<City>sample string 12</City>
<DivisionId>sample string 3</DivisionId>
<DivisionImage>sample string 5</DivisionImage>
<DivisionName>sample string 4</DivisionName>
<EIN>sample string 8</EIN>
<FormationDate>sample string 7</FormationDate>
<IsHead>true</IsHead>
<Logo>sample string 24</Logo>
<ManagerEmail>sample string 6</ManagerEmail>
<ManagerMobile>sample string 9</ManagerMobile>
<ManagerName>sample string 1</ManagerName>
<MobileAppOrder>20</MobileAppOrder>
<ProviderId>f98a6afc-823c-4237-a9ae-c6861bffcf39</ProviderId>
<ProviderOperatorsCredentialRenewalsCount>22</ProviderOperatorsCredentialRenewalsCount>
<ProviderOperatorsPendingCurrentStatusCount>23</ProviderOperatorsPendingCurrentStatusCount>
<ProviderUniqueCode>sample string 15</ProviderUniqueCode>
<RenewalsCount>21</RenewalsCount>
<Stage>sample string 18</Stage>
<StageDescription>sample string 19</StageDescription>
<State>sample string 13</State>
<Status>sample string 16</Status>
<StatusVideoUrl>sample string 17</StatusVideoUrl>
<Zip>sample string 14</Zip>
</BusinessEntityDto>
<BusinessEntityDto>
<Address1>sample string 10</Address1>
<Address2>sample string 11</Address2>
<BusinessName>sample string 2</BusinessName>
<City>sample string 12</City>
<DivisionId>sample string 3</DivisionId>
<DivisionImage>sample string 5</DivisionImage>
<DivisionName>sample string 4</DivisionName>
<EIN>sample string 8</EIN>
<FormationDate>sample string 7</FormationDate>
<IsHead>true</IsHead>
<Logo>sample string 24</Logo>
<ManagerEmail>sample string 6</ManagerEmail>
<ManagerMobile>sample string 9</ManagerMobile>
<ManagerName>sample string 1</ManagerName>
<MobileAppOrder>20</MobileAppOrder>
<ProviderId>f98a6afc-823c-4237-a9ae-c6861bffcf39</ProviderId>
<ProviderOperatorsCredentialRenewalsCount>22</ProviderOperatorsCredentialRenewalsCount>
<ProviderOperatorsPendingCurrentStatusCount>23</ProviderOperatorsPendingCurrentStatusCount>
<ProviderUniqueCode>sample string 15</ProviderUniqueCode>
<RenewalsCount>21</RenewalsCount>
<Stage>sample string 18</Stage>
<StageDescription>sample string 19</StageDescription>
<State>sample string 13</State>
<Status>sample string 16</Status>
<StatusVideoUrl>sample string 17</StatusVideoUrl>
<Zip>sample string 14</Zip>
</BusinessEntityDto>
</data>
<message>sample string 2</message>
<status>1</status>
</ApiResponseNewOfArrayOfBusinessEntityDtoqfWPY2Au>