POST Provider/OnLineStatusChangeRequirementGet

OnLineStatusChangeRequirementGet

Request Information

URI Parameters

None.

Body Parameters

ParaProviderOnlineStatusChange
NameDescriptionTypeAdditional information
GoOnline

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "GoOnline": true
}

application/xml, text/xml

Sample:
<ParaProviderOnlineStatusChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <GoOnline>true</GoOnline>
</ParaProviderOnlineStatusChange>

Response Information

Resource Description

ResultProviderOnlineStatusChange
NameDescriptionTypeAdditional information
PopUpTitle

string

None.

NeedAsk

boolean

None.

CodeListTitle

string

None.

OffReasonCodeList

Collection of ProviderOffReasonCode

None.

VideoOptionCodeList

Collection of ResultCode

None.

EstimatedMinutesList

Collection of integer

None.

OffReasonCodeId

integer

None.

VideoOptionCodeId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "PopUpTitle": "sample string 1",
  "NeedAsk": true,
  "CodeListTitle": "sample string 2",
  "OffReasonCodeList": [
    {
      "CodeId": 1,
      "CodeShort": "sample string 2",
      "allowDetailInput": true,
      "allowEstimatedMinutesList": true
    },
    {
      "CodeId": 1,
      "CodeShort": "sample string 2",
      "allowDetailInput": true,
      "allowEstimatedMinutesList": true
    }
  ],
  "VideoOptionCodeList": [
    {
      "Category": "sample string 1",
      "CodeId": 2,
      "CodeShort": "sample string 3",
      "CodeLong": "sample string 4",
      "SortOrder": "sample string 5",
      "SystemLanguageId": 6,
      "Available": true
    },
    {
      "Category": "sample string 1",
      "CodeId": 2,
      "CodeShort": "sample string 3",
      "CodeLong": "sample string 4",
      "SortOrder": "sample string 5",
      "SystemLanguageId": 6,
      "Available": true
    }
  ],
  "EstimatedMinutesList": [
    1,
    2
  ],
  "OffReasonCodeId": 1,
  "VideoOptionCodeId": 1
}

application/xml, text/xml

Sample:
<ResultProviderOnlineStatusChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <CodeListTitle>sample string 2</CodeListTitle>
  <EstimatedMinutesList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EstimatedMinutesList>
  <NeedAsk>true</NeedAsk>
  <OffReasonCodeId>1</OffReasonCodeId>
  <OffReasonCodeList>
    <ProviderOffReasonCode>
      <CodeId>1</CodeId>
      <CodeShort>sample string 2</CodeShort>
      <allowDetailInput>true</allowDetailInput>
      <allowEstimatedMinutesList>true</allowEstimatedMinutesList>
    </ProviderOffReasonCode>
    <ProviderOffReasonCode>
      <CodeId>1</CodeId>
      <CodeShort>sample string 2</CodeShort>
      <allowDetailInput>true</allowDetailInput>
      <allowEstimatedMinutesList>true</allowEstimatedMinutesList>
    </ProviderOffReasonCode>
  </OffReasonCodeList>
  <PopUpTitle>sample string 1</PopUpTitle>
  <VideoOptionCodeId>1</VideoOptionCodeId>
  <VideoOptionCodeList>
    <ResultCode>
      <Available>true</Available>
      <Category>sample string 1</Category>
      <CodeId>2</CodeId>
      <CodeLong>sample string 4</CodeLong>
      <CodeShort>sample string 3</CodeShort>
      <SortOrder>sample string 5</SortOrder>
      <SystemLanguageId>6</SystemLanguageId>
    </ResultCode>
    <ResultCode>
      <Available>true</Available>
      <Category>sample string 1</Category>
      <CodeId>2</CodeId>
      <CodeLong>sample string 4</CodeLong>
      <CodeShort>sample string 3</CodeShort>
      <SortOrder>sample string 5</SortOrder>
      <SystemLanguageId>6</SystemLanguageId>
    </ResultCode>
  </VideoOptionCodeList>
</ResultProviderOnlineStatusChange>