Message Namespace
The message namespace contains the resource to manage the messages with the following methods Method Endpoint Scope Description.
| Operation | Method | Endpoint | Scope | Sample | Description |
| Update Message | Put | message/message_id | Message | Sample | Update Message |
| Get Message | Get | message/message_id | Message | Sample | Get Message |
| Inquiry Messsage | Get | message/inquiry | Message | Sample | Inquiry Messsage |
| Delete Message | Delete | message/message_id | Message | Sample | Delete Message |
Data Object
| Field Name | Field Type | Regular Expression | Sample | Field Status | |||
| POST | PUT | GET | DELETE | ||||
| message_data | |||||||
| info Security Type: None |
Object | None | NA | NA | NA | NA | |
| content Security Type: None |
Object | None | NA | NA | NA | NA | |
| replay Security Type: None |
Object | None | NA | NA | NA | NA | |
| action Security Type: None |
Object | None | NA | NA | NA | NA | |
| geo_coordinates Security Type: None |
Object | None | NA | NA | NA | NA | |
| custom_field Security Type: None |
Object | None | NA | NA | NA | NA | |
| notes Security Type: None |
Object | None | NA | NA | NA | NA | |
| last_activity Security Type: None |
Object | None | NA | NA | NA | NA | |
| validate Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | NA | NA | NA | NA |
| authentication Security Type: None |
Object | None | O | O | O | O | |
| info | |||||||
| id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | NA | NA |
| program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | NA | NA |
| bin_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| sender_entity Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| sender_entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| recipient_entity Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| recipient_entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| service_provider Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| delivery_method Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | NA | NA |
| direction Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | NA | NA |
| template_type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| status Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | C | NA | NA |
| source_time_zone Security Type: None |
String | ^((?:UTC [+|-](?:2[0-3]|[01][0-9]):[0-5][0-9])){1,10}$ | UTC -06:00, UTC +02:30 | NA | NA | NA | NA |
| source_language Security Type: None |
String | None | NA | NA | NA | NA | |
| display_type Security Type: None |
Object | None | NA | NA | NA | NA | |
| original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | NA | NA | NA | NA |
| expiry_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
| server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
| date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
| content | |||||||
| from Security Type: None |
String | None | NA | NA | NA | NA | |
| to Security Type: None |
String | None | NA | NA | NA | NA | |
| cc Security Type: None |
String | None | NA | NA | NA | NA | |
| bcc Security Type: None |
String | None | NA | NA | NA | NA | |
| type Security Type: None |
Integer | None | NA | NA | NA | NA | |
| language Security Type: None |
String | None | NA | NA | NA | NA | |
| title Security Type: None |
String | None | NA | NA | NA | NA | |
| display_name Security Type: None |
String | None | NA | NA | NA | NA | |
| body Security Type: None |
String | None | NA | NA | NA | NA | |
| display_type Security Type: None |
Object | None | NA | NA | NA | NA | |
| attachment Security Type: None |
Object | None | NA | NA | NA | NA | |
| replay | |||||||
| entity Security Type: None |
Integer | None | NA | NA | NA | NA | |
| entity_id Security Type: None |
Integer | None | NA | NA | NA | NA | |
| server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
| date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
| content Security Type: None |
Object | None | NA | NA | NA | NA | |
| action | |||||||
| id Security Type: None |
String | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| status Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| necessity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| expiry_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
| reminder_time Security Type: None |
String | ^(([01][0-9])|([2][0-3])):[0-5][0-9]$ | 03:03 | NA | NA | NA | NA |
| reminder_count Security Type: None |
Integer | ^[0-9]{1,4}$ | 9000 | NA | NA | NA | NA |
| escalation Security Type: None |
Object | None | NA | NA | NA | NA | |
| geo_coordinates | |||||||
| latitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | 37.42242 | NA | NA | NA | NA |
| longitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | 37.42242 | NA | NA | NA | NA |
| position_description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,255}$ | Abc00, fʁɑ̃s123 | NA | NA | NA | NA |
| notes | |||||||
| user_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,255}$) | Abc000000 | NA | NA | NA | NA |
| admin_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,255}$) | Abc000000 | NA | NA | NA | NA |
| last_activity | |||||||
| entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
| entity_data Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | NA | NA | NA | NA |
| activity_type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | NA | NA |
| notes Security Type: None |
Object | None | NA | NA | NA | NA | |
| update_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
| authentication | |||||||
| type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
| code Security Type: Encrypted |
String | ^[ A-Za-z0-9_.\/#=&+-]*$ | UN7C-KKT98L-4HAU | O | O | O | O |
Message Query Parameters
| Field Name | Field Type | Regular Expression | Sample | Field Status | |||
| POST | PUT | GET | DELETE | ||||
| message_inquiry | |||||||
| page_index Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | NA | NA | O | NA |
| page_size Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | NA | NA | O | NA |
| program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
| user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
| type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | O | NA |
| template_type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | O | NA |
| direction Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | O | NA |
| delivery_method Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | O | NA |
| source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | NA | NA | O | NA |
| status Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | O | NA |
| from_date Security Type: None |
String | ^([0-9]{4})[\/|-]((0[1-9])|(1[0-2]))[\/|-]((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))$ | 2006-06-12, 2006/06/12 (yyyy-mm-dd or yyyy/mm/dd) | NA | NA | O | NA |
| to_date Security Type: None |
String | ^([0-9]{4})[\/|-]((0[1-9])|(1[0-2]))[\/|-]((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))$ | 2006-06-12, 2006/06/12 (yyyy-mm-dd or yyyy/mm/dd) | NA | NA | O | NA |
| include_failed Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | NA | NA | O | NA |
| recipient_entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | O | NA |
| recipient_entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
Update Message
Update Message
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Get Message
Get Message
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Inquiry Messsage
Inquiry Messsage
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|
Delete Message
Delete Message
| Configuration Header: |
|
| Configuration Query Parameters: |
|
| Request Parameters: |
|
| Response Parameters: |
|