Access User View - Guest Management

Preregister Guest

Preregister a guest with specified information.

Interface URI

/uam/guest/preRegister

Access Method

HTTP
POST
Message body
<guestUserPreRegister>
  <fullName>test001</fullName>
  <certification>test001</certification>
  <address>test001</address>
  <phone>82771234</phone>
  <email>1@sina.com</email>
  <userName>test001</userName>
  <guestManagerName>dyb01</guestManagerName>
  <userPassword>test001</userPassword>
  <guestDepartment>test001</guestDepartment>
  <guestHost>test001</guestHost>
  <onlineLimit>1</onlineLimit>
</guestUserPreRegister>
Element description
guestUserPreRegister subelements
fullName Guest name.
String type. Required. No default value. The string cannot exceed 32 characters.
certification Identity number.
String type. Required. No default value. The string cannot exceed 32 characters.
address Address.
String type. Optional. No default value. The string cannot exceed 127 characters.
phone Phone number.
String type. Optional. The string cannot exceed 32 characters, and can only contain digits, plus sign (+), minus sign (-), left parenthesis ((), right parenthesis ()), and spaces.
email Email address.
String type. Optional. The string cannot exceed 64 characters, and can only contain letters, digits, minus sign (-), underscore (_), dot (.), and at sign (@). Valid value format is xxx@yyy.zzz.
userName Account name.
String type. Required. No default value. The account name is string of 1 to 32 characters and cannot contain tabs, consecutive spaces, or any of the following special characters: # + / ? % & = * ' @ \ " [] ()`
guestManagerName Guest manager.
String type. Required. No default value. The string cannot exceed 32 characters.
userPassword Password.
String type. Required. No default value. The string cannot exceed 32 characters.
guestDepartment Reception department.
String type. Optional. No default value. The string cannot exceed 128 characters.
guestHost Receptionist.
String type. Optional. No default value. The string cannot exceed 16 characters.
onlineLimit Maximum number of concurrent logins allowed for the access user.
Integer type. Optional. The default value is 1. Valid value range is 1 to 255.

Return Values

Status codes
  • 201 (Created): Success.
  • 409 (Conflict): Failure.
Error codes
Error codes
62400 The value cannot be empty.
62401 Invalid parameter value.
62403 The account name already exists.
62475 The guest name and identity number are already used by a preregistered guest.
62476 The system does not allow preregistering guests.
62480 The guest manager does not exist.
Message header

If the operation succeeds, the Location field gives the URI of the new resource. The message body is empty. 
HTTP/1.1 201 Created
Location: http://localhost:8080/imcrs/uam/guest/preRegister/preguest001

Example

Preregister a guest.

Request
POST http://inc_host:8080/imcrs/uam/guest/preRegister
accept: application/xml 
Content-Type: application/xml; charset=UTF-8 
... 
<guestUserPreRegister>
  <fullName>test001</fullName>
  <certification>test001</certification>
  <address>test001</address>
  <phone>82771234</phone>
  <email>1@sina.com</email>
  <userName>test001</userName>
  <guestManagerName>dyb01</guestManagerName>
  <userPassword>test001</userPassword>
  <guestDepartment>test001</guestDepartment>
  <guestHost>test001</guestHost>
  <onlineLimit>1</onlineLimit>
</guestUserPreRegister>
Response
HTTP/1.1 201 Created
Location: http://localhost:8080/imcrs/uam/guest/preRegister/test001