The update
service is used to synchronize on-site installations of CLAIMS Direct. This service is used directly by apgupd.
Table of Contents |
---|
/check
Check the availability of updates.
Method | GET | ||
---|---|---|---|
Path | /update/check | ||
Parameter | |||
@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
Code Block |
---|
wget -O- -q \ --header 'x-user:x' --header 'x-password:y' \ 'http://cdws21.ificlaims.com/update/check?max_client_modified_load_id=260221&limit=1' |
...
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:
|
/next
Fetch the next available load
Method | GET | ||
---|---|---|---|
Path | /update/next | ||
Parameter | |||
@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' \ 'http://cdws21.ificlaims.com/update/next?max_client_modified_load_id=260221' |
...