GET v1/provider/v2/home?UserId={UserId}&includePending={includePending}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
UserId

string

None.

includePending

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

ApiResponseNewOfProviderHomeResponseDto
NameDescriptionTypeAdditional information
status

integer

None.

message

string

None.

data

ProviderHomeResponseDto

None.

Response Formats

application/json, text/json

Sample:
{
  "status": 1,
  "message": "sample string 2",
  "data": {
    "providerCredentialRenewalsCount": 1,
    "providerOperatorsCredentialRenewalsCount": 2,
    "notificationCount": 3,
    "files": [
      {
        "key": 1,
        "value": "sample string 2",
        "description": "sample string 3",
        "type": "sample string 4"
      },
      {
        "key": 1,
        "value": "sample string 2",
        "description": "sample string 3",
        "type": "sample string 4"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ApiResponseNewOfProviderHomeResponseDtoqfWPY2Au xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OrionDAL.ApiModels.Version1">
  <data>
    <NotificationCount>3</NotificationCount>
    <ProviderCredentialRenewalsCount>1</ProviderCredentialRenewalsCount>
    <ProviderOperatorsCredentialRenewalsCount>2</ProviderOperatorsCredentialRenewalsCount>
    <Result>
      <Message>sample string 1</Message>
      <Status>2</Status>
    </Result>
    <files>
      <FileMediaResponseVM>
        <Description>sample string 3</Description>
        <Key>1</Key>
        <Type>sample string 4</Type>
        <Value>sample string 2</Value>
      </FileMediaResponseVM>
      <FileMediaResponseVM>
        <Description>sample string 3</Description>
        <Key>1</Key>
        <Type>sample string 4</Type>
        <Value>sample string 2</Value>
      </FileMediaResponseVM>
    </files>
  </data>
  <message>sample string 2</message>
  <status>1</status>
</ApiResponseNewOfProviderHomeResponseDtoqfWPY2Au>