The update
service is used to synchronize on-site installations of CLAIMS Direct. This service is used directly by apgupd.
/check
Check the availability of updates.
| | | | | | @max_client_modified_load_id | integer: e.g., 251234 | The maximum modified_load_id in the table xml.t_patent_document_values of the on-site PostgreSQL database |
|
| @limit | integer: e.g., 10 | Number of load structures to return. Default: 10 |
...
Example
Request
...
...
--header 'x-user:x' \ --header 'x-password:y' \ |
...
...
https://cdws21.ificlaims.com/update/check?max_client_modified_load_id=260221&limit=1' |
Response
Code Block |
---|
|
{
"status" : "success",
"time" : "0.112",
"load_info" : {
"start_load_id" : 260222,
"earliest" : "2017-03-22 22:13:03.325308",
"end_load_id" : 260247,
"nloads" : "19",
"latest" : "2017-03-23 05:10:34.620999",
"loads" : [
{
"session_id" : "000000260222-IFI-Cont",
"load_source" : "IFI-Cont",
"completed_stamp" : "2017-03-22 22:13:03.325308",
"load_id" : 260222,
"running_status" : "complete",
"entered_stamp" : "2017-03-22 22:12:59.04867",
"completed_status" : "success",
"client_extract_process_id" : 121592,
"url" : "httphttps://alexandria.fairviewresearch.com/dwh/20170322/000000260222-IFI-Cont.tar.gz",
"ndocs" : 1,
"server_name" : "adbbr02"
}
]
}
} |
Details
JSON Member | Description |
---|
status | Request status (success | failed) |
time | Time, in seconds, to complete the request |
load_info | Structure representing pending load information |
.start_load_id | The next load id available to be processed |
.end_load_id | The last load id available to be processed |
.earliest | Timestamp of earliest available load. This is the timestamp that the load was processed on the CLAIMS Direct primary platform. |
.latest | Timestamp of latest available load. This is the timestamp that the load was processed on the CLAIMS Direct primary platform. |
.nloads | Number of pending loads. This number may not be the same as end_load_id - start_load_id as not all load id(s) are applicable to every subscription level. |
.loads | An array of load structures consisting of: JSON Member | Description |
---|
load_source | The load source for this load id. See the load sources documentation for details. | load_id | The load identifier | ndocs | Number of documents contained in this load | url | The URL of the package to download (HTTP Basic Authentication) | entered_stamp | Internal | running_status | Internal | completed_stamp | Internal | completed_status | Internal | session_id | Internal | client_extract_process_id | Internal | server_name | Internal |
|
/next
Fetch the next available load.
| | | | @max_client_modified_load_id | Integer: e.g., 251234 | The maximum modified_load_id in the table xml.t_patent_document_values of the on-site PostgreSQL database |
Example
Request
Code Block |
---|
|
wget -O- -q \
--header 'x-user:x' \
--header 'x-password:y' \
'httphttps://cdws21.ificlaims.com/update/next?max_client_modified_load_id=260221' |
Response
Code Block |
---|
|
{
"status" : "success",
"time" : "0.111",
"load_info" : {
"session_id" : "000000260222-IFI-Cont",
"load_source" : "IFI-Cont",
"completed_stamp" : "2017-03-22 22:13:03.325308",
"load_id" : 260222,
"running_status" : "complete",
"entered_stamp" : "2017-03-22 22:12:59.04867",
"completed_status" : "success",
"client_extract_process_id" : 121592,
"url" : "httphttps://alexandria.fairviewresearch.com/dwh/20170322/000000260222-IFI-Cont.tar.gz",
"ndocs" : 1,
"server_name" : "adbbr02"
}
} |
Please see above for a detailed description of the response members.
/info
Fetch information pertaining to a particular load-id.
Method | GET |
---|
Path | /update/info |
Parameter |
| Values | Description |
| @load_id | Integer: e.g., 372122 | The modified-load-id of interest |
Example
Request
Code Block |
---|
|
wget -O- -q \
--header 'x-user:x' \
--header 'x-password:y' \
'https://cdws21.ificlaims.com/update/info?load_id=372122' |
Response
Code Block |
---|
|
{
"status" : "success",
"time" : "0.105",
"load_info" : {
"priority" : 0,
"load_source" : "DOCDB",
"completed_stamp" : "2019-07-18 10:35:28.128316",
"load_id" : 372122,
"office" : "EP",
"running_status" : "complete",
"completed_status" : "success",
"entered_stamp" : "2019-07-18 10:24:37.959904",
"ndocs" : 1
}
} |
The load_info
structure members are described below.
Member | Description |
---|
priority | The load priority. A higher priority positions this load in front of those with low priorities. |
load_source | The load source. Please see a description of available load sources. |
completed_stamp | Time stamp load was completed |
load_id | The modified-load-id |
office | The issuing authority |
running_status | Running state of load |
completed_status | Completed status of load |
entered_stamp | Time stamp of load begin |
ndocs | Number of documents contained in this load |