POST api/grp/HuntGroup?locationAccountNumber={locationAccountNumber}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationAccountNumber

string

Required

Body Parameters

HuntGroupEditDTO
NameDescriptionTypeAdditional information
UserId

string

None.

Name

string

None.

LastName

string

None.

FirstName

string

None.

Policy

integer

None.

AllowCallWaitingForAgents

boolean

None.

TimeZone

string

None.

AllowControlGroupBusy

boolean

None.

EnableGroupBusy

boolean

None.

ApplyGroupBusyWTCA

boolean

None.

NoAnswerSkipEnable

boolean

None.

NoAnswerSkip

integer

None.

NoAnswerForwardAfterTimeout

boolean

None.

NoAnswerForwardTimeoutSeconds

integer

None.

NoAnswerForwardTo

string

None.

NotReachableEnable

boolean

None.

NotReachableTo

string

None.

NotReachableMakeHuntGroupBusy

boolean

None.

CallingLineIDDefault

boolean

None.

CallingLineIDIncludeHuntGroup

boolean

None.

Department

DepartmentKeyDTO

None.

MonitoredUsers

Collection of UserAssignDTO

None.

HuntingUsers

Collection of UserAssignDTO

None.

AvailableUsers

Collection of UserAssignDTO

None.

Departments

Collection of DepartmentKeyDTO

None.

TimeZones

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "UserId": "sample string 1",
  "Name": "sample string 2",
  "LastName": "sample string 3",
  "FirstName": "sample string 4",
  "Policy": 5,
  "AllowCallWaitingForAgents": true,
  "TimeZone": "sample string 7",
  "AllowControlGroupBusy": true,
  "EnableGroupBusy": true,
  "ApplyGroupBusyWTCA": true,
  "NoAnswerSkipEnable": true,
  "NoAnswerSkip": 12,
  "NoAnswerForwardAfterTimeout": true,
  "NoAnswerForwardTimeoutSeconds": 14,
  "NoAnswerForwardTo": "sample string 15",
  "NotReachableEnable": true,
  "NotReachableTo": "sample string 17",
  "NotReachableMakeHuntGroupBusy": true,
  "CallingLineIDDefault": true,
  "CallingLineIDIncludeHuntGroup": true,
  "Department": {
    "DepartmentName": "sample string 1",
    "IsEnterprise": true
  },
  "MonitoredUsers": [
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    },
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    }
  ],
  "HuntingUsers": [
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    },
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    }
  ],
  "AvailableUsers": [
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    },
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    }
  ],
  "Departments": [
    {
      "DepartmentName": "sample string 1",
      "IsEnterprise": true
    },
    {
      "DepartmentName": "sample string 1",
      "IsEnterprise": true
    }
  ],
  "TimeZones": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<HuntGroupEditDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Group">
  <AllowCallWaitingForAgents>true</AllowCallWaitingForAgents>
  <AllowControlGroupBusy>true</AllowControlGroupBusy>
  <ApplyGroupBusyWTCA>true</ApplyGroupBusyWTCA>
  <AvailableUsers xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
  </AvailableUsers>
  <CallingLineIDDefault>true</CallingLineIDDefault>
  <CallingLineIDIncludeHuntGroup>true</CallingLineIDIncludeHuntGroup>
  <Department xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
    <d2p1:DepartmentName>sample string 1</d2p1:DepartmentName>
    <d2p1:IsEnterprise>true</d2p1:IsEnterprise>
  </Department>
  <Departments xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
    <d2p1:DepartmentKeyDTO>
      <d2p1:DepartmentName>sample string 1</d2p1:DepartmentName>
      <d2p1:IsEnterprise>true</d2p1:IsEnterprise>
    </d2p1:DepartmentKeyDTO>
    <d2p1:DepartmentKeyDTO>
      <d2p1:DepartmentName>sample string 1</d2p1:DepartmentName>
      <d2p1:IsEnterprise>true</d2p1:IsEnterprise>
    </d2p1:DepartmentKeyDTO>
  </Departments>
  <EnableGroupBusy>true</EnableGroupBusy>
  <FirstName>sample string 4</FirstName>
  <HuntingUsers xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
  </HuntingUsers>
  <LastName>sample string 3</LastName>
  <MonitoredUsers xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
  </MonitoredUsers>
  <Name>sample string 2</Name>
  <NoAnswerForwardAfterTimeout>true</NoAnswerForwardAfterTimeout>
  <NoAnswerForwardTimeoutSeconds>14</NoAnswerForwardTimeoutSeconds>
  <NoAnswerForwardTo>sample string 15</NoAnswerForwardTo>
  <NoAnswerSkip>12</NoAnswerSkip>
  <NoAnswerSkipEnable>true</NoAnswerSkipEnable>
  <NotReachableEnable>true</NotReachableEnable>
  <NotReachableMakeHuntGroupBusy>true</NotReachableMakeHuntGroupBusy>
  <NotReachableTo>sample string 17</NotReachableTo>
  <Policy>5</Policy>
  <TimeZone>sample string 7</TimeZone>
  <TimeZones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </TimeZones>
  <UserId>sample string 1</UserId>
</HuntGroupEditDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.