| Oracle® Communications Service Broker VPN Implementation Guide Release 6.0 Part Number E23531-02 |
|
|
View PDF |
| Oracle® Communications Service Broker VPN Implementation Guide Release 6.0 Part Number E23531-02 |
|
|
View PDF |
This chapter describes the VPN Provisioning API, a RESTful application programming interface for configuring and administering an Oracle Communications Service Broker VPN implementation.
For each operation in the API, this chapter lists the parameters accepted and returned by the operation and provides examples of HTTP requests and responses.
All JSON body parameters for POST (create) operations are required unless indicated as optional in the parameter description. For PUT (modify) operations, the request only needs to contain the attributes to be changed.
Note:
In the request and response message examples in this chapter, line breaks and spaces have been added to the JSON data in the body of the message to improve readability.Creates an administrative user account in the system. The administrative user uses the VPN Provisioning API to configure VPN services.
There are two types of administrative users:
Provider administrators (role 1) have privileges to invoke all API operations, including operations applicable to VPN instances. This role is intended for administrative users in the provider organization.
Subscriber administrators (role 4) have privileges to invoke operations only within the context of the VPN subscriber organization to which they belong. This role is usually occupied by a person, group, or application within the subscribing organization.
For each operation in the API, the role of the administrator permitted to invoke the operation is indicated in the User Authorization sections.
If security is enabled for the API, invoking an API operation requires administrative user credentials in the form of basic authentication credentials.
Provider administrator
POST
/vpn/admins
Request body parameters are:
adminName: (string) The user name for the administrative user account. Must be 64 characters or less and start with a letter followed by any combination of word characters and spaces.
adminPassword: (string) The password for the administrator account. Must be 64 characters or less.
role: (integer) The role of the administrator. The role determines the authorization privileges for the user. Possible values are:
1: Administrative user with system-wide privileges, including the ability to modify provider settings and create additional administrative users.
4: Administrative user for a particular VPN subscriber instance identified by the vpnID parameter.
vpnID: (string) For a role 4 administrator, the identifier of the VPN subscriber instance for which the user is an administrator.
This parameter is mandatory for both types of administrators. However, note that a role 1 administrator is not associated with a specific VPN. For administrators with this role, you must include the vpnID parameter with a hyphen character as its value (that is, "vpnID":"-").
Empty
Example 8-1 Request: Create Subscriber Administrator
POST /vpn/admins HTTP/1.1
Host: 10.148.126.81
Accept: */*
Content-Length:83
{"adminName":"oracle_admin",
"adminPassword":"password",
"role":4,
"vpnID":"oracle"}
Returns a list of administrators in the system. Each administrator is identified by user name and URI.
Provider administrator
GET
/vpn/admins
Empty
The response body contains:
A list of administrators, where each administrator is represented as:
"adminName":"URI"
For example, an administrator named admin001 would be identified as:
"admin001":"http://localhost:9001/vpn/admin/admin001"
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 227
Server: Jetty(8.0.1.0)
[{"admin003":"http://10.148.126.22:80/vpn/admin/admin003"},
{"admin":"http://10.148.126.22:80/vpn/admin/admin"},
{"admin001":"http://10.148.126.22:80/vpn/admin/admin001"},
{"admin002":"http://10.148.126.22:80/vpn/admin/admin002"}]
Returns information about a specific provider or subscriber administrator.
Provider administrator or subscriber administrator
GET
/vpn/admin/admin_name
Empty
Response body parameters are:
adminName: (string) The user name of the administrator.
role: (integer) The role of the administrator. The role determines the authorization privileges for the administrator. Possible values are:
1: Administrative user with system-wide privileges, including the ability to modify provider settings and create additional administrative users.
4: Administrative user for a particular VPN subscriber instance identified by the vpnID parameter.
vpnID: (string) For role 4 users, the identifier of the VPN subscriber instance associated with the administrator. For role 1 users, this parameter is not included in the response.
isSecurity: (boolean) An attribute of the built-in admin user. This switch indicates whether the API requires user credentials in requests. This setting is not available for user-created provider or subscriber administrators.
isBulk: (boolean) An attribute of the built-in admin user. This switch indicates whether application data loaded through the batch operation tools or the API is validated prior to loading. If true, data is not validated. This setting is not available for user-created provider or subscriber administrators
Changes settings for an administrative user.
For a provider administrator, you use this operation to change password, enable bulk operations in the API, or enable authentication for API access.
For a subscriber administrator, you use this operation to modify a password only. The user name, role, and VPN ID values for administrators cannot be modified. To change these values, you must delete the administrator and create a new one with the desired user name, role, or VPN ID.
Provider administrator
PUT
/vpn/admin/admin_name
Request body parameters are:
adminPassword: (string) Password associated with the administrative user account. Must be 64 characters or less.
isSecurity: (boolean) An attribute of the built-in admin user only. Indicates whether the API requires user credentials in requests. If true, requests to the API must include valid provider administrator credentials in Basic Auth format.
This setting is not available for user-created provider or subscriber administrators.
isBulk: (boolean) An attribute of the built-in admin user only. Indicates whether application data loaded through the batch operation tools or the API is validated prior to loading. If true, data is not validated.
This setting is not available for user-created provider or subscriber administrators
Empty
PUT /vpn/admin/sysadmin HTTP/1.1
Host: 10.148.126.36
Accept: */*
{"adminPassword":"password"}
Removes an administrative user account from the system, disabling access to the VPN Provisioning API for the account user.
You cannot remove a subscriber administrator if it is the only administrator for the VPN subscriber. You must first delete the subscriber instance before you are permitted to remove the administrator for that subscriber.
The built-in admin administrator account cannot be deleted.
Subscriber administrator
DELETE
/vpn/admin/username
Empty
Empty
Returns information about the service provider organization, including general properties for the provider and global VPN settings, such as the global call barring list.
There can be only one VPN service provider object in the system. It is created automatically and cannot be deleted.
Provider administrator or subscriber administrator
GET
vpn/sp
Empty
Response body parameters are:
name: (string) The name of the service provider organization.
address: (string) The address of the service provider.
description: (string) A description of the service provider organization.
privateCallMarker: (string) A dialed number prefix that identifies the call as a private call. Private calls are identified in the log and circumvent calling restrictions.
pbxPrefix: (string) The numeric prefix associated with PBX-originated calls. The service switching point (SSP) uses this value to trigger VPN services.
localCountryCode: (string) The local country dialing code.
localAreaCode: (string) The local area dialing code.
mtcSuppressionPrefix: (string) The mobile-terminated call (MTC) suppression prefix is a number that the VPN application prepends to the call destination number to indicate to the SSP that the originating and terminating services have been invoked in a single IN dialog.
The purpose of the prefix is to indicate to the SSP that it should not invoke terminating services. The SSP should strip the prefix before further processing the call.
callBarringBlackList: (string array) A comma-separated list of numbers that represent the call destinations to which calls from VPN users in this provider are blocked.
numberRange: (string array) The public phone numbers of the service provider. The numbers may include wildcard characters to indicate a range (for example, 5982*, 5981*). The VPN application uses this value to determine whether called or calling numbers are within the service provider's network for purposes of call restriction. That is, an access control item can define a restriction for calls conditional on whether the parties are inside or outside the service provider's network.
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 270
Server: Jetty(8.0.1.0)
{"callBarringBlackList":[],
"localAreaCode":"10",
"numberRange":["86139*","86138*"],
"address":"",
"localCountryCode":"86",
"description":"Mobile Telecommunication operations, worldwide",
"name":"Mobile Telco",
"pbxPrefix":"",
"mtcSuppressionPrefix":"22",
"privateCallMarker":"7"}
Changes settings for the service provider. The service provider object contains general properties for the provider organization along with global VPN settings, such as a global call barring list. The global settings apply to all VPN subscribers in the system.
There can be only one VPN service provider object in the system. It is created automatically and cannot be deleted.
Provider administrator or subscriber administrator
PUT
vpn/sp
Request body parameters are:
name: (string) The name of the service provider organization. Must be 64 characters or less and start with a letter followed by any combination of word characters and spaces.
address: (string) The address of the service provider organization. The length of this value is limited only by the size of the table field allocated for it in data storage, which is 512 bytes by default.
description: (string) A description of the service provider organization. The length of this value is limited only by the size of the table field allocated for it in data storage, which is 256 bytes by default.
privateCallMarker: (string) A dialed number prefix that identifies the call as a private call. Private calls are identified in the log and circumvent calling restrictions. Must be 2 digits or less.
pbxPrefix: (string) The numeric prefix associated with PBX-originated calls. The service switching point (SSP) uses this value to trigger VPN services.
localCountryCode: (string) The local country dialing code.
localAreaCode: (string) The local area dialing code.
mtcSuppressionPrefix: (string) The mobile-terminated call (MTC) suppression prefix is a number that the VPN application prepends to the call destination number to indicate to the SSP that the originating and terminating services have been invoked in a single IN dialog.
The purpose of the prefix is to indicate to the SSP that it should not invoke terminating services. The SSP should strip the prefix before further processing the call.
callBarringBlackList: (string array) A comma-separated list of numbers that represent call destinations to which calls from VPN users in this provider are blocked. You can specify the barred caller as a phone number, wildcarded number prefix (1888*), or IP address.
numberRange: (string array) Identifies the public phone numbers of the service provider. The numbers may include wildcard characters to indicate a range (for example, 5982*, 5981*). The VPN application uses this value to determine whether called or calling numbers are within the service provider's network for purposes of call restriction. That is, an access control item can define a restriction for calls conditional on whether the parties are inside or outside the service provider's network.
Empty
PUT /vpn/sp HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:144
{
"address":"500 Main St, Redwood Shores, CA",
"callBarringBlackList":["2894*","499*","18665555555"],
"numberRange":["86139*","86138*","86140*"]}
HTTP/1.1 200 OK Content-Type: application/text Content-Length: 257 Server: Jetty(8.0.1.0) Modify the sp successfully. Possible effective fields include: 1.name; 2.address; 3.description; 4.privateCallMarker; 5.pbxPrefix; 6.localCountryCode; 7.localAreaCode; 8.mtcSuppressionPrefix; 9.callBarringBlackList; 10.numberRange. Other fields are ignored.
Creates a subscriber object, which contains settings for a particular organization that subscribes to VPN services. You must create a subscriber object for each organization for which you are making VPN services available.
Before you can call this operation, the subscriber administrator account associated with the subscriber instance must exist.
Provider administrator or subscriber administrator
POST
/vpn/subscribers
Request body parameters are:
vpnID: (string) A unique identifier for the VPN Subscriber object. Other objects in the data model, such as partner and administrator definitions, use this value to reference this subscriber instance. Must be 64 characters or less and start with a letter followed by any combination of word characters.
name: (string) The name of the VPN subscriber organization. Must be 64 characters or less and start with a letter followed by any combination of word characters and spaces.
escapeCode: (string) Optional. A numeric escape code that, when preceding a dialed number, causes the dialed number to circumvent number translation by the VPN module. Must be 2 digits or less.
privateCallEnable: (boolean) Whether private calling is enabled for this subscriber. The default value is false.
privateNumberCLI: (boolean) The calling line identification presentation mode for the VPN subscriber. If true, the private number is forwarded for presentation on the terminating device. If false, the public number is forwarded for presentation on the terminating device. The default value is false.
maxExtensionNumberLength: (integer) The maximum number of digits that can be used for extensions that are allocated for devices for this VPN subscriber. The value must be from 2 to 10 digits.
forcedOnNet: (boolean) If true, specifies that when an end user dials the public number of another on-net user instead of that user's extension, the call is treated as an on-net call. The default value is false.
partnerVPNSwitch: (boolean) Whether the partner VPN feature is enabled for this subscriber. If true, the provider can apply differentiated charging rates to calls between members of this VPN and the VPN subscribers identified in the partnerVPN attribute. The default value is false.
timeZone: (integer) The time zone for this subscriber. The time value is used for certain type of policy evaluation scenarios, such as calling restrictions based on time of day. Specify the time zone as the hour offset from UTC.
The time zone setting can also be set at the profile level, allowing for a geographically distributed organization.
exclusionList: (string array) Optional. Extension numbers or prefixes of numbers that cannot be allocated as private extensions for this subscriber. Specify a range of numbers using the wildcard symbol (*).
callBarringBlackList: (string array) Optional. A comma-separated list of numbers that represent call destination to which outgoing calls from users in this subscriber are blocked. You can specify the barred caller as a phone number, wildcarded number prefix (1888*), or IP address.
callScreeningBlackList: (string array) Optional. A comma-separated list of numbers that represent call sources from which incoming calls to users in this subscriber are blocked. You can specify the source as a phone number, wildcarded number prefix (1888*), or IP address.
partnerVPN: (string array) Optional. A list of vpnID values that represent the partner organizations of this subscriber.
worktimeID: (string) Optional. The identifier of the working time object that defines the working hours for this subscriber. The VPN application uses this value to evaluate rules based on working hours.
Empty
POST /vpn/subscribers HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:331
{"callScreeningBlackList":[],
"exclusionList":[],
"maxExtensionNumberLength":4,
"callBarringBlackList":["2894*","499*","18665555555"],
"escapeCode":"0",
"timeZone":8,
"vpnID":"vpn004",
"privateNumberCLI":false,
"forcedOnNet":true,
"partnerVPNSwitch":true,
"name":"company004",
"partnerVPN":["vpn002"],
"privateCallEnable":true,
"worktimeID":""}
HTTP/1.1 200 OK Content-Type: application/text Content-Length: 343 Server: Jetty(8.0.1.0) Add the vpnsubscriber successfully. Possible effective fields include: 1.vpnID; 2.name; 3.escapeCode; 4.privateCallEnable; 5.privateNumberCLI; 6.maxExtensionNumberLength; 7.forcedOnNet; 8.partnerVPNSwitch; 9.timeZone; 10.exclusionList; 11.callBarringBlackList; 12.callScreeningBlackList; 13.partnerVPN; 14.worktimeID. Other fields are ignored.
Returns a list of subscribers in the system. Each subscriber in the list is represented by its vpnID name and URI.
Provider administrator
GET
/vpn/subscribers/
Empty
The response body contains:
A list of subscribers, where each subscriber is identified in the form:
"vpnID":"URI"
For example, a subscriber with an ID of vpn001 would be identified as:
"vpn001":"http://localhost:9001/vpn/subscriber/vpn001"
Returns information on a particular subscriber.
Provider administrator or subscriber administrator
GET
/vpn/subscriber/vpn_id
Empty
Response body parameters are:
name: (string) The name of the VPN subscriber organization.
escapeCode: (string) An escape code that, when preceding a dialed number, causes the dialed number to circumvent number translation by the VPN module.
privateCallEnable: (boolean) Whether private calling is enabled for this subscriber.
privateNumberCLI: (boolean) The calling line identification presentation mode for the VPN subscriber. If true, the private number is forwarded for presentation on the terminating device. If false, the public number is forwarded for presentation on the terminating device.
maxExtensionNumberLength: (integer) The maximum number of digits that can be used for extensions that are allocated for devices for this VPN subscriber.
forcedOnNet: (boolean) If true, specifies that when an end user dials the public number of another on-net user instead of that user's extension, the call is treated as an on-net call.
partnerVPNSwitch: (boolean) Whether the partner VPN feature is enabled for this subscriber. If true, the provider can apply differentiated charging rates to calls between members of this VPN and the VPN subscribers identified in the partnerVPN attribute.
timeZone: (integer) The time zone for this subscriber. The time value is used for certain type of policy evaluation scenarios, such as calling restrictions based on time of day. The time zone value is the hour offset from UTC.
exclusionList: (string array) Extension numbers or prefixes of numbers that cannot be allocated as private extensions for this subscriber.
callBarringBlackList: (string array) A comma-separated list of numbers that represent call destinations to which calls from VPN users in this provider are blocked.
callScreeningBlackList: (string array) A comma-separated list of numbers that represent call sources from which incoming calls to users in this subscriber are blocked.
partnerVPN: (string array) A list of vpnID values that represent the partner organizations of this subscriber.
worktimeID: (string) The identifier of the working time object that defines the working hours for this subscriber. The VPN application uses this value to evaluate rules based on working hours.
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 323
Server: Jetty(8.0.1.0)
{"callScreeningBlackList":[],
"exclusionList":[],
"maxExtensionNumberLength":4,
"callBarringBlackList":["2894*","499*","18665555555"],
"escapeCode":"0",
"timeZone":8,
"vpnID":"vpn002",
"privateNumberCLI":false,
"forcedOnNet":true,
"partnerVPNSwitch":true,
"name":"company002",
"partnerVPN":[],
"privateCallEnable":true,
"worktimeID":""}
Changes settings for a subscriber.
Provider administrator or subscriber administrator
PUT
/vpn/subscriber/vpn_id
Request body parameters are:
name: (string) The name of the VPN subscriber organization. Must be 64 characters or less and start with a letter followed by any combination of word characters and spaces.
escapeCode: (string) An escape code that, when preceding a dialed number, causes the dialed number to circumvent number translation by the VPN module. Must be 2 digits or less.
privateCallEnable: (boolean) Whether private calling is enabled for this subscriber. The default value is false.
privateNumberCLI: (boolean) The calling line identification presentation mode for the VPN subscriber. If true, the private number is forwarded for presentation on the terminating device. If false, the public number is forwarded for presentation on the terminating device. The default value is false.
maxExtensionNumberLength: (integer) The maximum number of digits that can be used for extensions that are allocated for devices for this VPN subscriber. The length can be from 2 to 10 digits.
forcedOnNet: (boolean) If true, specifies that when an end user dials the public number of another on-net user instead of that user's extension, the call is treated as an on-net call. The default value is false.
partnerVPNSwitch: (boolean) Whether the partner VPN feature is enabled for this subscriber. If true, the provider can apply differentiated charging rates to calls between members of this VPN and the VPN subscribers identified in the partnerVPN attribute. The default value is false.
timeZone: (integer) The time zone for this subscriber. The time value is used for certain type of policy evaluation scenarios, such as calling restrictions based on time of day. You specify the time zone as an hour offset from UTC.
exclusionList: (string array) Extension numbers or prefixes of numbers that cannot be allocated as private extensions for this subscriber. Specify a range of numbers using the wildcard symbol (*).
callBarringBlackList: (string array) A comma-separated list of numbers that represent call destination to which outgoing calls from users in this subscriber are blocked. You can specify the barred caller as a phone number, wildcarded number prefix (1888*), or IP address.
callScreeningBlackList: (string array) A comma-separated list of numbers that represent call sources from which incoming calls to users in this subscriber are blocked. You can specify the source as a phone number, wildcarded number prefix (1888*), or IP address.
partnerVPN: (string array) A list of vpnID values that represent the partner organizations of this subscriber.
worktimeID: (string) The identifier of the working time object that defines the working hours for this subscriber. The VPN application uses this value to evaluate rules based on working hours.
Empty
PUT /vpn/subscriber/vpn004 HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:34
{"partnerVPN":["vpn002","vpn003"]}
HTTP/1.1 200 OK Content-Type: application/text Content-Length: 336 Server: Jetty(8.0.1.0) Modify the vpnsubscriber successfully. Possible effective fields include: 1.name; 2.escapeCode; 3.privateCallEnable; 4.privateNumberCLI; 5.maxExtensionNumberLength; 6.forcedOnNet; 7.partnerVPNSwitch; 8.timeZone; 9.exclusionList; 10.callBarringBlackList; 11.callScreeningBlackList; 12.partnerVPN; 13.worktimeID. Other fields are ignored.
Removes a subscriber definition from the system. Removing the subscriber removes all VPN users, policies, groups, and other objects associated with the subscriber.
Provider administrator or subscriber administrator
DELETE
/vpn/subscriber/vpn_id
Empty
Empty
Creates a virtual user for a subscriber. A virtual user is a VPN user that is external to the subscribing organization. Calls to the virtual user are considered on-net, but calls from the virtual user to other types of VPN users are not.
Provider administrator or subscriber administrator
POST
/vpn/subscriber/vpn_id/virtualusers
Request body parameters are:
name: (string) An identifying name for the virtual user. Must be 64 characters or less and start with a letter followed by any combination of word characters and spaces.
phoneExtension: (string) The private extension for the virtual user. This is the phone extension used from within the VPN to call the virtual user. Must meet the extension length requirement for the subscriber, and may contain digits or digits followed by an asterisk (*).
publicPhoneNumber: (string) The public phone number of the virtual user. Must be 20 characters or less, and contain all digits or digits followed by an asterisk (*) or preceded with a plus character (+).
Empty
POST /vpn/subscriber/vpn003/virtualusers HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length: 100
{
"phoneExtension":"4999",
"publicPhoneNumber":"861030004999",
"name":"travelagentcontact"
}
Returns a list of virtual users for a subscriber. Each virtual user is identified by its public number and URL.
Provider administrator or subscriber administrator
GET
vpn/subscriber/vpn_id/virtualusers
Empty
The response body contains:
A list of virtual users, where each virtual user is identified in the form:
"publicPhoneNumber":"URI"
For example, a virtual user with a public phone number of 861030009999 would be identified as:
"86103009999": "http://host:9001/vpn/subscriber/vpn3/virtualuser/86103009999"
GET /vpn/subscriber/vpn003/virtualusers HTTP/1.1 Host: 10.148.126.22 Accept: */*
Returns information on a specific virtual user.
Provider administrator or subscriber administrator
GET
/vpn/subscriber/vpn_id/virtualuser/public_phone_number
Empty
Request body parameters are:
name: (string) An identifying name for the virtual user.
phoneExtension: (string) The private extension for the virtual user.
publicPhoneNumber: (string) The public phone number of the virtual user.
GET /vpn/subscriber/vpn003/virtualuser/861030009999 HTTP/1.1 Host: 10.148.126.22 Accept: */*
Changes settings for a virtual user, including the virtual user's name or phone extension. To change the public number for a user, you must remove the existing virtual user object and create a new one with the desired number.
Provider administrator or subscriber administrator
PUT
/vpn/subscriber/vpn_id/virtualuser/publicPhoneNumber
Request body parameters are:
name: (string) An identifying name for the virtual user. Must be 64 characters or less and start with a letter followed by any combination of word characters and spaces.
phoneExtension: (string) The private extension for the virtual user. Must meet the extension length requirement for the subscriber, and may contain digits or digits followed by an asterisk (*).
Empty
PUT /vpn/subscriber/vpn003/virtualuser/861030009999 HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:25
{"phoneExtension":"8999"}
Removes a virtual user from the subscriber.
Provider administrator or subscriber administrator
DELETE
/vpn/subscriber/vpn_id/virtualuser/publicPhoneNumber
Empty
Empty
DELETE /vpn/subscriber/vpn003/virtualuser/861030004999 HTTP/1.1 Host: 10.148.126.22 Accept: */*
Creates a VPN user object, which represents an on-net mobile or PBX on-net device.
For a mobile user, the VPN user defines properties such as the user's group membership and usage policy. For a PBX user, you specify the public phone number, phone extension, and member type parameters for the user. The phone extension and public phone number usually take the form of a number range. The other VPN user parameters do not apply to a PBX VPN user.
Provider administrator or subscriber administrator
POST
/vpn/subscriber/vpn_id/users
Request body parameters are:
publicPhoneNumber: (string) The public phone number of the user device. For a PBX device, this can be a range, specified by a wildcard symbol. Must be 20 characters or less, and contain all digits or digits followed by an asterisk (*) or preceded with a plus character (+).
phoneExtension: (string) The private extension for the user device.
For a PBX device, this can be a range of extensions specified by a numeric prefix. The phone extension range should provide a one-to-one correspondence with the public phone number range. For example:
"phoneExtension" : "11*"
"publicPhoneNumber" : "17240011*"
In this case, public phone number 1724001101 would map to extension 1101, 1724001102 to extension 1102, and so on.
The parameter value must meet the extension length requirement for the subscriber, and may contain digits or digits followed by an asterisk (*).
memberType: (integer) The user type, with these options:
0: Mobile on-net member
1: PBX on-net member or members.
closedUserGroupID: (string) Optional. The identifier of an existing user group to which this mobile device should be assigned. This parameter does not apply to PBX users.
homeProfileID: (string) Optional. The identifier of an existing policy profile that applies to this mobile device when operated within its home network. This parameter does not apply to PBX users.
roamingProfileID: (string) Optional. The identifier of an existing policy profile that applies to this mobile device when operated outside of its home network. This parameter does not apply to PBX users.
personID: (string) Optional. The identifier of the end user associated with this mobile device as defined in an existing person object. This parameter does not apply to PBX users.
privateCallEnable: (boolean) Whether the mobile device can be used for private calls. This parameter does not apply to PBX users. The default value is false.
Empty
POST /vpn/subscriber/vpn001/users HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:205
{"phoneExtension":"1115",
"publicPhoneNumber":"861391001015",
"memberType":0,
"homeProfileID":"",
"closedUserGroupID":"bjManager",
"privateCallEnable":false,
"roamingProfileID":"",
"personID":""}
HTTP/1.1 200 OK Content-Type: application/text Content-Length: 235 Server: Jetty(8.0.1.0) Add the vpnuser successfully. Possible effective fields include: 1.publicPhoneNumber; 2.phoneExtension; 3.memberType; 4.closedUserGroupID; 5.homeProfileID; 6.roamingProfileID; 7.personID; 8. privateCallEnable. Other fields are ignored.
Returns a list of users in the system. Each user is represented by the public number of the device and URI.
Provider administrator or subscriber administrator
GET
/vpn/subscriber/vpn_id/users
Empty
The response body contains:
A list of users, where each user is represented as:
"publicPhoneNumber":"URI":
For example, a user with a public number of 861391001001 would be identified as:
"861391001001" : "http://localhost:9001/vpn/subscriber/vpn001/user/861391001001"
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 576
Server: Jetty(8.0.1.0)
[{"861391001002":
"http://10.148.126.22:80/vpn/subscriber/vpn001/user/861391001002"},
{"861391001001":
"http://10.148.126.22:80/vpn/subscriber/vpn001/user/861391001001"},
{"861391001003":
"http://10.148.126.22:80/vpn/subscriber/vpn001/user/861391001003"},
{"861391001005":
"http://10.148.126.22:80/vpn/subscriber/vpn001/user/861391001005"},
{"861391001110":
"http://10.148.126.22:80/vpn/subscriber/vpn001/user/861391001110"},
{"86101000111*":
"http://10.148.126.22:80/vpn/subscriber/vpn001/user/86101000111*"},
{"17240011*":
"http://10.148.126.22:80/vpn/subscriber/vpn001/user/17240011*"}]
Returns information on a specific user by public phone number or, for a PBX user, by phone number range.
Provider administrator or subscriber administrator
GET
/vpn/subscriber/vpn_id/user/public_phone_number
Empty
Response body parameters are:
publicPhoneNumber: (string) The public phone number of the user device. For a PBX device, this can be a range, specified by a wildcard symbol.
phoneExtension: (string) The private extension for the user device. For a PBX device, this can be a range of extensions specified by a numeric prefix. The range should provide a one-to-one correspondence with the public phone number range.
memberType: (integer) The type of user device, with these options:
0: Mobile on-net member
1: PBX on-net member or members.
closedUserGroupID: (string) The identifier of the user group to which this mobile device belongs. This parameter does not apply to type 1, PBX users.
homeProfileID: (string) The identifier of the policy profile that applies to this mobile device when operated in its home network. This parameter does not apply to type 1, PBX users.
roamingProfileID: (string) The identifier of the policy profile that applies to this mobile device when operated outside of its home network. This parameter does not apply to type 1, PBX users.
privateCallEnable: (boolean) Whether the mobile device can be used for private calls. This parameter does not apply to type 1, PBX users.
vpnID: (string) The identifier for the VPN instance to which the user device belongs.
personID: (string) The name of the end user associated with this mobile device as defined by a person object. This parameter does not apply to type 1, PBX users.
privateCallEnable: (boolean) Whether the device can be used for private calls.
Example 8-41 Request: Get Mobile User
GET /vpn/subscriber/vpn001/user/861391001003 HTTP/1.1 Host: 10.148.126.22 Accept: */*
Example 8-42 Response: Get Mobile User
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 205
Server: Jetty(8.0.1.0)
{"phoneExtension":"1003",
"publicPhoneNumber":"861391001003",
"memberType":0,
"homeProfileID":"",
"closedUserGroupID":"bjManager",
"vpnID":"vpn001",
"privateCallEnable":false,
"roamingProfileID":"",
"personID":""}
Example 8-43 Request: Get PBX User
GET /vpn/subscriber/vpn001/user/17240011* HTTP/1.1 Host: 10.148.126.22 Accept: */*
Example 8-44 Response: Get PBX User
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 192
Server: Jetty(8.0.1.0)
{"phoneExtension":"11*",
"publicPhoneNumber":"17240011*",
"memberType":1,
"homeProfileID":"",
"closedUserGroupID":"",
"vpnID":"vpn001",
"privateCallEnable":false,
"roamingProfileID":"",
"personID":""}
Changes settings for a user device.
Provider administrator or subscriber administrator
PUT
/vpn/subscriber/vpn_id/user/public_phone_number
Request body parameters are:
phoneExtension: (string) The private extension for the user device. For a PBX device, this can be a range of extensions specified by a numeric prefix. The phone extension range should provide a one-to-one correspondence with the public phone number range. For example:
"phoneExtension" : "11*"
"publicPhoneNumber" : "17240011*"
In this case, public phone number 1724001101 would be mapped to extension 1101, and public number 1724001102 to extension 1102, and so on.
The parameter value must meet the extension length requirement for the subscriber, and may contain digits or digits followed by an asterisk (*).
memberType: (integer) The user type, with these options:
0: Mobile on-net member
1: PBX on-net member or members.
closedUserGroupID: (string) The identifier of an existing user group to which this mobile device should be assigned. This parameter does not apply to PBX users.
homeProfileID: (string) The identifier of an existing policy profile that applies to this mobile device when operated in its home network. This parameter does not apply to PBX users.
roamingProfileID: (string) The identifier of an existing policy profile that applies to this mobile device when operated outside of its home network. This parameter does not apply to PBX users.
personID: (string) The identifier of the end user associated with this mobile device as defined in an existing person object. This parameter does not apply to PBX users.
privateCallEnable: (boolean) Whether the mobile device can be used for private calls. This parameter is not relevant to type 1, PBX users. The default value is false.
Empty
Removes a user device from the system.
Provider administrator or subscriber administrator
DELETE
/vpn/subscriber/vpn_id/user/public_phone_number
Empty
Empty
DELETE /vpn/subscriber/vpn001/user/861391001001 HTTP/1.1 Host: 10.148.126.22 Accept: */*
Creates a profile, which defines a particular usage policy for VPN users.
Provider administrator or subscriber administrator
POST
vpn/subscriber/vpnID/profiles/
Request body parameters are:
profileID: (string) A unique name for the profile definition. Must be 64 characters or less and start with a letter, and may contain any combination of letters, numbers, and underscore characters. Must be 64 characters or less and start with a letter followed by any combination of word characters.
description: (string) Optional. A description for the profile. The length of this value is limited only by the size of the table field allocated for it in data storage, which is 256 bytes by default.
worktimeID: (string) The identifier of the working time object that defines the working hours for this subscriber. The VPN application uses this value to evaluate rules based on working hours.
timeZone: (integer) The time zone for this subscriber. The time value is used for certain type of policy evaluation scenarios, such as calling restrictions based on time of day. Specify the time zone as the hour offset from UTC.
callBarringList: (object array) Optional. A list of access control items that define outgoing call barring rules for the VPN. See "Using Access Control Rules" for information about the object format.
callScreeningList: (object array) Optional. A list of access control items that define incoming call screening rules for the VPN. See "Using Access Control Rules" for information about the object format.
durationControlList: (integer array) Optional. Call duration limits for various types of calls on the VPN. The array is made up of four numbers that represent the maximum number of seconds for calls of these types, respectively: within the VPN subscriber, outside the VPN subscriber, national, and international.
For each item, 99999 means no limit.
Empty
POST /vpn/subscriber/vpn001/profiles HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:325
{"durationControlList":[99999,99999,99999,7200],
"profileID":"hqProfile",
"description":"The headquarters group profile",
"callScreeningList":[],
"timeZone":6,
"callBarringList":[
{"range":"17909*","timeSpan":0,"permit":false,"type":0},
{"range":"17910*","timeSpan":0,"permit":false,"type":0}],
"worktimeID":""}
HTTP/1.1 200 OK Content-Type: application/text Content-Length: 207 Server: Jetty(8.0.1.0) Add the profile successfully. Possible effective fields include: 1.profileID; 2.description; 3.worktimeID; 4.timeZone; 5.callScreeningList; 6.callBarringList; 7.durationControlList. Other fields are ignored.
Returns a list of profiles in the system. Each profile is represented by its profile ID and URI.
Provider administrator or subscriber administrator
GET
vpn/subscriber/vpnID/profiles/
Empty
The response body contains:
A list of profiles, where each profile is represented as:
"profileID":"URI":
For example, a profile with an ID of hqProfile would be identified as:
"hqprofile":"http://localhost:9001/vpn/subscriber/vpn001/profile/hqprofile"
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 561
Server: Jetty(8.0.1.0)
[{"bjGroupProfile":
"http://10.148.126.22:80/vpn/subscriber/vpn001/profile/bjGroupProfile"},
{"bjEmployeeProfile":
"http://10.148.126.22:80/vpn/subscriber/vpn001/profile/bjEmployeeProfile"},
{"alicehomeProfile":
"http://10.148.126.22:80/vpn/subscriber/vpn001/profile/alicehomeProfile"},
{"aliceroamProfile":
"http://10.148.126.22:80/vpn/subscriber/vpn001/profile/aliceroamProfile"},
{"bjManagerProfile":
"http://10.148.126.22:80/vpn/subscriber/vpn001/profile/bjManagerProfile"},
{"johnhomeProfile":
"http://10.148.126.22:80/vpn/subscriber/vpn001/profile/johnhomeProfile"}]
Returns information on a specific profile.
Provider administrator or subscriber administrator
GET
vpn/subscriber/vpnID/profile/profile_ID
Empty
Response body parameters are:
profileID: (string) A unique name for the profile definition.
vpnID: (string) The identifier of the VPN subscriber instance to which the profile belongs.
description: (string) A description for the profile.
worktimeID: (string) A reference to the working time object that defines the working hours for this subscriber. The VPN application uses this value to evaluate rules based on working hours.
timeZone: (integer) The time zone for this subscriber. The time value is used for certain type of policy evaluation scenarios, such as calling restrictions based on time of day. Specify the time zone as the hour offset from UTC.
callBarringList: (object array) A list of access control items that define outgoing call barring rules for the VPN. See "Using Access Control Rules" for information about the object format.
callScreeningList: (object array) A list of access control items that define incoming call screening rules for the VPN. See "Using Access Control Rules" for information about the object format.
durationControlList: (integer array) Call duration limits for various types of calls on the VPN. The array is made up of four numbers that represent the maximum number of seconds for calls of these types, respectively: within the VPN subscriber, outside the VPN subscriber, national, and international.
For each item, 99999 means no limit.
GET /vpn/subscriber/vpn001/profile/bjGroupProfile HTTP/1.1 Host: 10.148.126.22 Accept: */*
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 264
Server: Jetty(8.0.1.0)
{"durationControlList":[99999,99999,99999,99999],
"profileID":"bjGroupProfile",
"description":"this is bj group profile",
"callScreeningList":[],
"timeZone":8,
"callBarringList":[
{"range":"17909*","timeSpan":0,"permit":false,"type":0}],
"vpnID":"vpn001",
"worktimeID":""}
Changes settings for a profile.
Provider administrator or subscriber administrator
PUT
vpn/subscriber/vpnID/profile/profile_ID
Request body parameters are:
description: (string) A description for the profile. The length of this value is limited only by the size of the table field allocated for it in data storage, which is 256 bytes by default.
worktimeID: (string) A reference to the working time object that defines the working hours for this subscriber. The VPN application uses this value to evaluate rules based on working hours.
timeZone: (integer) The time zone for this subscriber. The time value is used for certain type of policy evaluation scenarios, such as calling restrictions based on time of day. Specify the time zone as the hour offset from UTC.
callBarringList: (object array) A list of access control items that define outgoing call barring rules for the VPN. See "Using Access Control Rules" for information about the object format.
callScreeningList: (object array) A list of access control items that define incoming call screening rules for the VPN. See "Using Access Control Rules" for information about the object format.
durationControlList: (integer array) Call duration limits for various types of calls on the VPN. The array is made up of four numbers that represent the maximum number of seconds for calls of these types, respectively: within the VPN subscriber, outside the VPN subscriber, national, and international.
For each item, 99999 means no limit.
Empty
PUT /vpn/subscriber/vpn001/profile/bjGroupProfile HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:133
{"callBarringList":[
{"range":"17909*","timeSpan":0,"permit":false,"type":0},
{"range":"17910*","timeSpan":0,"permit":false,"type":0}]}
HTTP/1.1 200 OK Content-Type: application/text Content-Length: 197 Server: Jetty(8.0.1.0) Modify the profile successfully. Possible effective fields include: 1.description; 2.worktimeID; 3.timeZone; 4.callScreeningList; 5.callBarringList; 6.durationControlList. Other fields are ignored.
Removes a profile from the system. For the operation to succeed, the profile cannot be referenced by a user or user group.
Provider administrator or subscriber administrator
DELETE
vpn/subscriber/vpnID/profile/profile_ID
Empty
Empty
DELETE /vpn/subscriber/vpn001/profile/hqProfile HTTP/1.1 Host: 10.148.126.22 Accept: */*
Creates a closed user group, which is a group of mobile device users. Groups give you a way to manage the policy for multiple user devices at a time.
After creating a user group, you add users to it by specifying the group as the closedUserGroupID value in the user object.
Provider administrator or subscriber administrator
POST
vpn/subscriber/vpnID/closedgroups
Request body parameters are:
cugID: (string) A unique name for the user group. Must be 64 characters or less and start with a letter followed by any combination of word characters.
description: (string) Optional. A description for the user group. The length of this value is limited only by the size of the table field allocated for it in data storage, which is 512 bytes by default.
parentCugID: (string) Optional. The parent user group for this group. If a group has a parent group, users that belong to the child group must meet the policies of both child and parent group.
A group can have only one parent group. However, there can be multiple levels of parent-child groups. That is, the parent group itself can have a parent group.
homeProfileID: (string) Optional. The identifier of an existing policy profile that applies to this group of mobile devices when operated in their home network.
roamingProfileID: (string) Optional. The identifier of an existing policy profile that applies to this group of mobile devices when operated outside their home network.
privateCallEnable: (boolean) Whether the mobile devices in the group can be used for private calls. The default value is false.
Empty
POST /vpn/subscriber/vpn001/closedgroups HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:190
{"publicPhoneNumber":[],
"description":"",
"parentCugID":"",
"homeProfileID":"hqGroupProfile",
"cugID":"hqgroup",
"privateCallEnable":true,
"roamingProfileID":""}
HTTP/1.1 200 OK Content-Type: application/text Content-Length: 188 Server: Jetty(8.0.1.0) Add the vpngroup successfully. Possible effective fields include: 1.cugID; 2.description; 3.parentCugID; 4.privateCallEnable; 5.homeProfileID; 6.roamingProfileID. Other fields are ignored.
Returns a list of user groups in the system. Each group is represented by its group name (cugID) and URI.
Provider administrator or subscriber administrator
GET
vpn/subscriber/vpnID/closedgroups
Empty
The response body contains:
A list of user groups, where each group is represented as:
"userGroupID":"URI":
For example, a user group with an ID of hqgroup would be identified as:
"hqgroup":"http://localhost:9001/vpn/subscriber/vpn01/closedgroup/hqgroup"
GET /vpn/subscriber/vpn001/closedgroups HTTP/1.1 Host: 10.148.126.22 Accept: */*
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 331
Server: Jetty(8.0.1.0)
[{"bjgroup":
"http://10.148.126.22:80/vpn/subscriber/vpn001/closedgroup/bjgroup"},
{"bjEmployee":
"http://10.148.126.22:80/vpn/subscriber/vpn001/closedgroup/bjEmployee"},
{"bjManager":
"http://10.148.126.22:80/vpn/subscriber/vpn001/closedgroup/bjManager"},
{"hqgroup":
"http://10.148.126.22:80/vpn/subscriber/vpn001/closedgroup/hqgroup"}]
Returns information on a particular user group.
Provider administrator or subscriber administrator
GET
vpn/subscriber/vpnID/closedgroup/cug_ID
Empty
Response body parameters are:
cugID: (string) The name of the user group.
vpnID: (string) The identifier of the VPN subscriber instance to which the user group belongs.
description: (string) A description of the user group.
parentCugID: (string) The parent user group of this group.
homeProfileID: (string) The policy to be applied to users in the group when operating within their home network.
roamingProfileID: (string) The policy to be applied to users in the group when operating outside of their home network.
privateCallEnable: (boolean) Whether the mobile devices in the group can be used for private calls.
childCugIDs: (string array) Children user groups of this group. A child user group inherits and extends the policy specified in the parent user group.
Note that you cannot add child user groups directly. The value of this response parameter is derived from parent user group settings in the child groups.
publicPhoneNumber: (string array) The telephone numbers of the users that are direct members of this group.
Note that you do not add users by public number to a group directly. The value of this response parameter is derived from the group settings of individual user definitions.
GET /vpn/subscriber/vpn001/closedgroup/hqgroup HTTP/1.1 Host: 10.148.126.22 Accept: */*
HTTP/1.1 200 OK
Content-Type: application/text
Content-Length: 190
Server: Jetty(8.0.1.0)
{"publicPhoneNumber":[],
"description":"",
"parentCugID":"",
"homeProfileID":"hqGroupProfile",
"vpnID":"vpn001",
"cugID":"hqgroup",
"privateCallEnable":true,
"childCugIDs":[],
"roamingProfileID":""}
Changes settings for a user group.
Provider administrator or subscriber administrator
PUT
vpn/subscriber/vpnID/closedgroup/cug_ID
Request body parameters are:
description: (string) A description for the user group. The length of this value is limited only by the size of the table field allocated for it in data storage, which is 512 bytes by default.
parentCugID: (string) The parent user group for this group. If a group has a parent group, users that belong to the child group must meet the policies of both child and parent group.
A group can have only one parent group. However, there can be multiple levels of parent-child groups. That is, the parent group itself can have a parent group.
homeProfileID: (string) The policy to be applied to users in the group when operating within their home network.
roamingProfileID: (string) The policy to be applied to users in the group when operating outside of their home network.
privateCallEnable: (boolean) Whether the mobile devices in the group can be used for private calls. The default value is false.
Empty
PUT /vpn/subscriber/vpn001/closedgroup/hqgroup HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:60
{"description":"User group for headquarter-based employees"}
Removes a user group from the system. For the operation to succeed, the user group must not contain any users (that is, it cannot be referenced by a user definition), as indicated in the group's publicPhoneNumber attribute.
Provider administrator or subscriber administrator
DELETE
vpn/subscriber/vpnID/closedgroup/cug_ID
Empty
Empty
DELETE /vpn/subscriber/vpn001/closedgroup/hqgroup HTTP/1.1 Host: 10.148.126.22 Accept: */*
Creates a person object, which identifies a particular end user in the subscriber organization. A person object is referenced by one or more user objects, which associates the end use with a device
Provider administrator or subscriber administrator
POST
vpn/subscriber/vpnID/persons
Request body parameters are:
personID: (string) A unique identifier for the end user. Must be 64 characters or less and start with a letter followed by any combination of word characters.
name: (string) An informal name for the end user. Must be 32 characters or less and start with a letter followed by any combination of word characters and spaces.
Empty
POST /vpn/subscriber/vpn001/persons HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:70
{"name":"Alice M",
"personID":"alice"}
Returns a list of the person objects in the system. Each person object is represented by name and URI.
Provider administrator or subscriber administrator
GET
vpn/subscriber/vpnID/persons
Empty
The response body contains:
A list of persons, where each person is represented as:
"personID":"URI":
For example, a person with an ID of alice would be identified as:
"alice":"http://localhost:9001/vpn/subscriber/vpn001/person/alice"
Returns information on a particular person object.
Provider administrator or subscriber administrator
GET
vpn/subscriber/vpnID/person/personID
Empty
Response body parameters are:
name: (string) An informal name of the end user.
vpnID: (string) The identifier of the VPN subscriber instance to which the person belongs. The association is created through the user object that references the person.
vpnUserIDs: (string array) The list of users that reference this person object by public phone number.
personID: (string) The unique identifier of the end user.
GET /vpn/subscriber/vpn001/person/alice HTTP/1.1 Host: 10.148.126.22 Accept: */*
Changes settings for a particular person.
Provider administrator or subscriber administrator
PUT
vpn/subscriber/vpnID/person/personID
Request body parameters are:
name: (string) An informal name for the end user. Must be 32 characters or less and start with a letter followed by any combination of word characters and spaces.
Empty
PUT /vpn/subscriber/vpn001/person/alice HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:18
{"name":"Alice O"}
Removes a person from the subscriber. For the operation to succeed, the person cannot be referenced by a user object.
Provider administrator or subscriber administrator
DELETE
vpn/subscriber/vpnID/person/personID
Empty
Empty
DELETE /vpn/subscriber/vpn001/person/alice HTTP/1.1 Host: 10.148.126.22 Accept: */*
Defines the working time for a subscriber or profile. You can create call restriction rules that control calls based on a user's working times.
A working time definition is made up of four parameters, each of which contains an array of seven integers. Each integer represents a day of the week, starting on Sunday. The four parameters represent the starting hour, starting minutes, ending hour, and ending minutes. Hours are expressed as an integer, from 0 through 23 (representing a 24-hour based clock). Minutes are expressed as integers from 0 through 59.
For example, the following working time definition specifies a work time of 9:30 AM to 6:00 PM from Monday through Friday:
{
"startHour":[0,9,9,9,9,9,0],
"startMin":[0,30,30,30,30,30,0],
"endHour":[0,18,18,18,18,18,0],
"endMin":[0,0,0,0,0,0,0]
}
Provider administrator or subscriber administrator
POST
vpn/subscriber/vpnID/worktimes
Request body parameters are:
worktimeID: (string) A unique identifier for the work time definition. Must be 64 characters or less and start with a letter followed by any combination of word characters. See "JSON Body Parameters" for information about word characters.
startHour: (integer array) The hour when work starts each day. Specified as a seven integer array. Each item is a value from 0 to 23 that represents the starting hour. The first integer represents the Sunday start time and the last integer represents the Saturday start time.
startMin: (integer array) The minute when work starts each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 59 that represents the minute at which work starts. The first integer represents the Sunday start time and the last integer represents the Saturday start time.
endHour: (integer array) The hour when work terminates each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 23 that represents the ending hour. The first integer represents the Sunday end time and the last integer represents the Saturday end time.
endMin: (integer array) The minute when work terminates ends each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 59 that represents the minute when work ends. The first integer represents the Sunday end time and the last integer represents the Saturday end time.
Empty
POST /vpn/subscriber/vpn001/worktimes HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:164
{"startMin":[0,30,30,30,30,30,0],
"startHour":[0,7,7,7,7,7,10],
"endMin":[0,0,0,0,0,0,0],
"endHour":[0,16,16,16,16,16,14],
"worktimeID":"workingtime3"}
Returns a list of working time definitions in the system. Each working time definition is represented by name and URI.
Provider administrator
GET
vpn/subscriber/vpnID/worktimes
Empty
The response body contains:
A list of working time definitions, where each working time definition is represented as:
"workingTimeID":"URI":
For example, a working time with an ID of wt001 would be identified as:
"wt001":"http://localhost:9001/vpn/subscriber/vpn001/worktime/wt001"
Returns a particular working time definition.
Provider administrator or subscriber administrator
GET
vpn/subscriber/vpnID/worktime/worktimeID
Empty
Response body parameters are:
worktimeID: (string) The unique identifier of the work time definition.
vpnID: (string) The identifier of the VPN subscriber instance to which the work time belongs.
startHour: (integer array) The hour when work starts each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 23 that represents the starting hour. The first integer represents the Sunday start time and the last integer represents the Saturday start time.
startMin: (integer array) The minute when work starts each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 59 that represents the minute at which work starts. The first integer represents the Sunday start time and the last integer represents the Saturday start time.
endHour: (integer array) The hour when work terminates each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 23 that represents the ending hour. The first integer represents the Sunday end time and the last integer represents the Saturday end time.
endMin: (integer array) The minute when work terminates ends each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 59 that represents the minute when work ends. The first integer represents the Sunday end time and the last integer represents the Saturday end time.
GET /vpn/subscriber/vpn001/worktime/workingtime2 HTTP/1.1 Host: 10.148.126.22 Accept: */*
Changes settings for a particular working time definition.
Provider administrator or subscriber administrator
PUT
vpn/subscriber/vpnID/worktime/worktimeID
Request body parameters are:
startHour: (integer array) The hour when work starts each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 23 that represents the starting hour. The first integer represents the Sunday start time and the last integer represents the Saturday start time.
startMin: (integer array) The minute when work starts each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 59 that represents the minute at which work starts. The first integer represents the Sunday start time and the last integer represents the Saturday start time.
endHour: (integer array) The hour when work terminates each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 23 that represents the ending hour. The first integer represents the Sunday end time and the last integer represents the Saturday end time.
endMin: (integer array) The minute when work terminates ends each day. Specified as a seven integer array. Each integer is a value ranging from 0 to 59 that represents the minute when work ends. The first integer represents the Sunday end time and the last integer represents the Saturday end time.
Empty
PUT /vpn/subscriber/vpn001/worktime/workingtime3 HTTP/1.1
Host: 10.148.126.22
Accept: */*
Content-Length:33
{"endHour":[0,17,17,17,17,17,14]}
Removes a working time definition from the system. For this operation to succeed, the working time cannot be referenced by a subscriber or profile object.
Provider administrator or subscriber administrator
DELETE
vpn/subscriber/vpnID/worktime/worktimeID
Empty
Empty
DELETE /vpn/subscriber/vpn001/worktime/workingtime3 HTTP/1.1 Host: 10.148.126.22 Accept: */*
|
 Copyright © 2011, 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|