POST Provider/OnLineStatusChange
Change Provider's OnLine Status
Request Information
URI Parameters
None.
Body Parameters
ParaProviderOnlineStatus| Name | Description | Type | Additional information |
|---|---|---|---|
| isOnline | boolean |
None. |
|
| OffReasonCodeId | integer |
None. |
|
| OffReasonDetail | string |
None. |
|
| EstimatedMin | integer |
None. |
|
| VideoOptionCodeId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"isOnline": true,
"OffReasonCodeId": 1,
"OffReasonDetail": "sample string 1",
"EstimatedMin": 1,
"VideoOptionCodeId": 1
}
application/xml, text/xml
Sample:
<ParaProviderOnlineStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models"> <EstimatedMin>1</EstimatedMin> <OffReasonCodeId>1</OffReasonCodeId> <OffReasonDetail>sample string 1</OffReasonDetail> <VideoOptionCodeId>1</VideoOptionCodeId> <isOnline>true</isOnline> </ParaProviderOnlineStatus>
Response Information
Resource Description
ResultProviderOnLineStatus| Name | Description | Type | Additional information |
|---|---|---|---|
| ProviderId | integer |
None. |
|
| ProviderOnlineStatusCodeId | integer |
None. |
|
| StatusDisplay | string |
None. |
|
| OffLineReasonCodeId | integer |
None. |
|
| OffLineReasonCode | string |
None. |
|
| OffLineReasonDetail | string |
None. |
|
| EstimateOffTime | integer |
None. |
|
| VideoOptionCodeId | integer |
None. |
|
| VideoOption | string |
None. |
|
| CanChangeVideoOption | boolean |
None. |
|
| VideoOptionCodeList | Collection of ResultCode |
None. |
Response Formats
application/json, text/json
Sample:
{
"ProviderId": 1,
"ProviderOnlineStatusCodeId": 1,
"StatusDisplay": "sample string 2",
"OffLineReasonCodeId": 1,
"OffLineReasonCode": "sample string 3",
"OffLineReasonDetail": "sample string 4",
"EstimateOffTime": 1,
"VideoOptionCodeId": 1,
"VideoOption": "sample string 5",
"CanChangeVideoOption": 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
}
]
}
application/xml, text/xml
Sample:
<ResultProviderOnLineStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
<CanChangeVideoOption>true</CanChangeVideoOption>
<EstimateOffTime>1</EstimateOffTime>
<OffLineReasonCode>sample string 3</OffLineReasonCode>
<OffLineReasonCodeId>1</OffLineReasonCodeId>
<OffLineReasonDetail>sample string 4</OffLineReasonDetail>
<ProviderId>1</ProviderId>
<ProviderOnlineStatusCodeId>1</ProviderOnlineStatusCodeId>
<StatusDisplay>sample string 2</StatusDisplay>
<VideoOption>sample string 5</VideoOption>
<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>
</ResultProviderOnLineStatus>