Accessing the ATIPXpress API
Authentication using Access Token Tool
Each API user must be authenticated before they are able to use the API. Your administrator has an Access Token Tool which can be used to create a token for you as an API user. These tokens are time limited and must be provisioned again after expiration. Please contact your administrator to request an access token.
How to Access the ATIPXpress API
If you have been provided with a valid access token, you can access the ATIPXpress API from your desktop search bar. Search for ATIPXpress API in your program files and select this program to open the ATIPXpress API application.
The methods available in the API are described in the Request Methods and Audit Methods sections of this document.
Note: You must have Request Type or Audit permissions within the application to use the Request and Audit methods, respectively.
Request Methods
The following sections provide details and steps to use the Request methods to query request data.
Get Request Status
You can use the Get Request Status method to retrieve the status of a specific request. This requires the exact ID of the request you are querying.
Note: You must have Request Type permissions within the application to access this method.
To use the Get Request Status function:
Under Requests, locate the id string field and enter the Request ID exactly as it appears in the application, then click Execute:
After clicking Execute, the request data appears in the Response Body as shown below.
There are options to (A) Copy this to your clipboard, or (B) Download the response body.
To use this function via URL, use the following string with the application URL in place of <AX-api-url>, and replacing the {id} with the request ID you are querying:
<AX-api-url>/requests/{id}/status An example URL is shown below:
Get Request
You can use the Get Request API to query for data on a specific request. This requires the exact Request ID.
Note: You must have Request Type permissions within the application to access this method.
This method returns the following Request details:
visibleRequestID: ID of the request
requestStatus: Status of the request
receivedDate: Date when the request was received.
closedDate: Date when the request was closed. It is null if request is active
requestTypeName: Request Type
actionOffice: Action Office
deliveryMode: Mode of delivery of response to the requester
feeWaiverStatus: Fee waiver status of the request
paymentStatus: Payment Status of the request
priority: Priority of the request
receivedMode: How the request was received
requesterCategory: Category to which the requester belongs to
reviewStatus: Review status of the request
targetDate: Target date to close the request
To use the Get Request Status function:
Under Requests, locate the id string field and enter the Request ID exactly as it appears in the application, then click Execute:
After clicking Execute, the request data appears in the Response Body as shown below.
There are options to (A) Copy this to your clipboard, or (B) Download the response body.
Get Requests
You can use the Get Requests API to query for requests with matching attributes.
Note: You must have Request Type permissions within the application to access this method.
Parameters
The parameters available within the Get Requests method are outlined in the following tables.
Request Status parameter options:
Parameter | Attribute |
|---|---|
Need | On Hold-Need Info/Clarification |
CWithheld | On Hold-Fee Related |
DAdded | Documents Added |
DD | Documents Delivered |
DF | Delivery Failed |
DP | Delivery Pending |
Amended | Amended |
Assigned | Assigned |
Canceled | Canceled |
Closed | Closed |
Completed | Disposition Accepted |
Received | Received |
Screened | Perfected |
ReqforDocs | Request for Docs Sent |
RvwPending | Review Pending |
RvwAprvd | Review Approved |
RvwDisApvd | Review Disapproved |
DAddRvwLog | Documents Added to Review Log |
Request Type Name Parameters:
Parameter | Example |
|---|---|
Request Type name, as found in Administration > Request Management | “FOIA”, “FOIA,APP” |
Action Office parameter options:
Parameter | Example |
|---|---|
Office Codes, as found in Administration > Organization Setup | “HQ”, “HQ,DC” |
Using the Get Requests Method
Follow the steps below to use the Get Requests method:
Under Post/requests, use the Request body to customize the query. Beside each parameter you are using, enter the Request data that you would like returned in the results:
The pageSize and pageNumber fields are required and configure the formatting for the returned results. pageSize indicates the number of items returned per page, and pageNumber dictates the current page number.
If you are using the receivedDateFrom or closedDateFrom fields, you must also use the receivedDateTo and closedDateTo fields, respectively.
Note: Dates follow UTC format and will take the hours and minutes as 00:00 unless specified. To fetch values for a specific date, either specify the time or use the following date. For example, to fetch values for 11/1/2023, use either 2023-11-01T23:59Z or 202311-02.
For details on each parameter, see the Get Request Parameters section. Remove any parameters you are not using in the query.
After executing the method, the output returns all Requests matching the parameters used in the Request Body.
Requests Count
This method returns the total number of requests found for the requested ID.
Parameters
{
"visibleRequestIDs": [
"string"
],
"receivedDateFrom": "2024-04-09T15:56:23.647Z",
"receivedDateTo": "2024-04-09T15:56:23.647Z",
"closedDateFrom": "2024-04-09T15:56:23.647Z",
"closedDateTo": "2024-04-09T15:56:23.647Z",
"requestStatus": [
"string"
],
"requestTypeName": [
"string"
],
"actionOffice": [
"string"
]}
Output
The number of requests that match with the filter
Request/Updaterequest
Update a request with the information that the user sent via JSON.
Parameters
{
"description": "string",
"requestedDate": "2024-04-09T15:57:02.503Z",
"receivedDate": "2024-04-09T15:57:02.503Z",
"officeCode": "string",
"requesterFirstName": "string",
"requesterLastName": "string",
"requesterEmail": "string",
"requesterCountry": "string",
"requesterZipCode": "string",
"requestUserEmail": "string",
"priority": "string",
"deliveryMode": "string",
"receiveMode": "string",
"requesterCategory": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"homePhone": "string",
"workPhone": "string",
"requestCustomFields": [
{
"fieldName": "string",
"dataType": "string",
"value": "string"
}
],
"requestDescriptionAttachments": [
{
"contentType": "string",
"fileData": "string",
"fileName": "string",
"fileSize": "string"
}
],
"expediteRequested": true,
"expediteDescription": "string",
"expediteStartDate": "2024-04-09T15:57:02.503Z",
"expediteDescriptionAttachments": [
{
"contentType": "string",
"fileData": "string",
"fileName": "string",
"fileSize": "string"
}
],
"feeWaiverRequested": true,
"feeWaiverDescription": "string",
"feeWaiverStart": "2024-04-09T15:57:02.503Z",
"feeWaiverDescriptionAttachments": [
{
"contentType": "string",
"fileData": "string",
"fileName": "string",
"fileSize": "string"
}
],
"linkedRequests": [
{
"id": 0,
"visibleRequestID": "string",
"requestStatus": "string",
"requestDisplayStatus": "string",
"linkedRequestId": 0,
"linkedAction": 0
}
],
"sentToCommissioner": {
"requestId": 0,
"isSentToCommissioner": "string",
"sentDate": "2024-04-09T15:57:02.503Z",
"responseDate": "2024-04-09T15:57:02.503Z",
"approvalStatus": "string",
"sentReason": "string",
"section32Notice": "string",
"subsectionCeased": "string",
"section35Formal": "string",
"section37Reports": "string",
"recommendations": "string",
"orders": "string",
"paSection31": "string",
"paSection33": "string",
"paSection35": "string",
"paCourtAction": "string"
},
"requestType": "string",
"visibleRequestId": "string",
"feeWaiverEnd": "2024-04-09T15:57:02.503Z", "expediteEndDate": "2024-04-09T15:57:02.503Z",
"lastPerfectedDate": "2024-04-09T15:57:02.503Z",
"perfectedDate": "2024-04-09T15:57:02.503Z",
"originalReceivedDate": "2024-04-09T15:57:02.503Z",
"shippingAddress1": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingState": "string",
"shippingCountry": "string",
"shippingZipCode": "string",
"billingAddress1": "string",
"billingAddress2": "string",
"billingCity": "string",
"billingState": "string",
"billingCountry": "string",
"billingZipCode": "string"
}
Output
Request/Createrequest
Create a request with the information that the user has specified.
Parameters
{
"requestType": "string",
"description": "string",
"requestedDate": "2024-04-09T16:01:59.757Z",
"receivedDate": "2024-04-09T16:01:59.757Z",
"officeCode": "string",
"requesterFirstName": "string",
"requesterLastName": "string",
"requesterEmail": "string",
"requesterCountry": "string",
"requesterZipCode": "string",
"requestUserEmail": "string",
"priority": "string",
"deliveryMode": "string",
"receiveMode": "string",
"requesterCategory": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"homePhone": "string",
"workPhone": "string",
"requestCustomFields": [
{
"fieldName": "string",
"dataType": "string",
"value": "string"
}
],
"requestDescriptionAttachments": [
{
"contentType": "string",
"fileData": "string",
"fileName": "string",
"fileSize": "string"
}
],
"expediteRequested": true,
"expediteDescription": "string",
"expediteStartDate": "2024-04-09T16:01:59.757Z",
"expediteDescriptionAttachments": [
{
"contentType": "string",
"fileData": "string",
"fileName": "string",
"fileSize": "string"
}
],
"feeWaiverRequested": true,
"feeWaiverDescription": "string",
"feeWaiverStart": "2024-04-09T16:01:59.757Z",
"feeWaiverDescriptionAttachments": [
{
"contentType": "string",
"fileData": "string",
"fileName": "string",
"fileSize": "string"
}
],
"linkedRequests": [
{
"id": 0,
"visibleRequestID": "string",
"requestStatus": "string",
"requestDisplayStatus": "string",
"linkedRequestId": 0,
"linkedAction": 0
}
],
"sentToCommissioner": {
"requestId": 0,
"isSentToCommissioner": "string",
"sentDate": "2024-04-09T16:01:59.757Z",
"responseDate": "2024-04-09T16:01:59.757Z",
"approvalStatus": "string",
"sentReason": "string",
"section32Notice": "string",
"subsectionCeased": "string",
"section35Formal": "string",
"section37Reports": "string",
"recommendations": "string",
"orders": "string",
"paSection31": "string",
"paSection33": "string",
"paSection35": "string",
"paCourtAction": "string"
}
}
Output
Requesters Methods
Requesters/get/requesterId/LocaleId
Retrieve the requester's information based on the ID and the requested language.
Parameters
RequesterID: Requester ID localeID: Locale ID(language)
Output
{
"requesterTypeId": 0, requester type
"prefix": 0, prefix type
"suffix": 0, sufix type
"lastName": "Default", requester last name
"firstName": "Default", requester first name
"middleName": "", requester middle name
"jobTitle": "", requester tittle job
"workPhone1": "", requester phone
"workPhone2": "", requester phone
"homePhone": "", requester phone
"mobile": "", requester phone
"fax": "", requester fax
"email": default@example.com, requester email
"company": "", requester company
"login": "default", requester login
"notes": null, requester notes
"loginActive": true, status of requester login active or not
"isLoginActive": true, status of requester login active or not
"deactiveReason": 0, reason of being deactivate the login
"createdById": 0, requester created by
"modifiedById": 0, requester modified by
"address1": "Default Address", requester address
"address2": "", requester address
"city": "Default City", requester city
"stateId": 0, requester state
"countryId": 0, requester country
"zipCode": "00000", requester zip code
"createdBy": "Default", requester created by name
"modifiedBy": "Default", requester modified by name
"delinquent": false, requester is delinquent
"isDelinquent": false, requester is delinquent
"syncFlag": true, requester is sync flag on
"isSyncFlag": true, requester is sync flag on
"createdDate": "0000-00-00T00:00:00.000", "modifiedDate": "0000-00-00T00:00:00.000",
"requesterType": "Default", requester type
"stateName": "Default State", requester state name
"countryName": "Default Country", requester country name
"prefixName": null, requester prefix name
"sufixName": null, requester suffix name
"localeId": 0, requester language
"updateRequestAddresses": 0, requester update address
"updateAddresses": 0, requester update address
"otherState": null, requester has another state
"customFields": [], requester has custom fields
"id": 0 requester id
}
Requesters/create
Create a requester based on the information provided by the user.
Parameters
{
"id": 0,
"requesterTypeId": 0,
"prefix": 0,
"suffix": 0,
"lastName": "string",
"firstName": "string",
"middleName": "string",
"jobTitle": "string",
"workPhone1": "string",
"workPhone2": "string",
"homePhone": "string",
"mobile": "string",
"fax": "string",
"email": "string",
"company": "string",
"login": "string",
"notes": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateId": 0,
"countryId": 0,
"zipCode": "string",
"localeId": 0,
"createdDate": "2024-04-09T16:05:22.627Z",
"modifiedDate": "2024-04-09T16:05:22.627Z",
"createdById": 0,
"modifiedById": 0,
"stateName": "string",
"otherState": "string",
"customFields": [
{
"customFieldId": "string",
"customFieldValue": "string",
"customFieldType": 1
}
]
}
Output
After executing the method the requester is created, and an output appears as shown below:
Requesters/Update
Update a requester based on the information provided by the user
Parameters
{
"id": 0,
"requesterTypeId": 0,
"prefix": 0,
"suffix": 0,
"lastName": "string",
"firstName": "string",
"middleName": "string",
"jobTitle": "string",
"workPhone1": "string",
"workPhone2": "string",
"homePhone": "string",
"mobile": "string",
"fax": "string",
"email": "string",
"company": "string",
"login": "string",
"notes": "string",
"address1": "string",
"address2": "string",
"city": "string",
"stateId": 0,
"countryId": 0,
"zipCode": "string",
"localeId": 0,
"createdDate": "2024-04-09T16:05:55.310Z",
"modifiedDate": "2024-04-09T16:05:55.310Z",
"createdById": 0,
"modifiedById": 0,
"stateName": "string",
"otherState": "string",
"customFields": [
{
"customFieldId": "string",
"customFieldValue": "string",
"customFieldType": 1
}
]
}
Output
After executing the requesters/update method, an output appears as shown in the following example:
Audit Methods
You can use the Audit Methods to query for User Actions and User Logins in the application.
User Actions
The UserActions method gets all user actions between two dates.
Note: You must have Audit permissions within the application to access this method.
To audit user actions using the API:
Locate the UserActions section of the API, as shown below:
Enter the dates you’d like to audit User Actions between using the FromDate and ToDate fields.
NOTE: Dates follow UTC format and will take the hours and minutes as 00:00 unless specified. To fetch values for a specific date, either specify the time or use the following date. For example, to fetch values for 11/1/2023, use either 2023-11-01T23:59Z or 202311-02.
The pageSize and pageNumber fields are required and configure the formatting for the returned results. pageSize indicates the number of items returned per page, and pageNumber dictates the current page number.
Execute the method to view matching results, which display in the Response body field. There are options to (A) Copy this to your clipboard, or (B) Download the response body
User Logins
You can use the UserLogins method to gets all user logins between two dates.
Note: Users utilizing Audit methods must have Audit permissions within the application.
To audit user logins using the API:
Locate the UserActions section of the API, as shown below:
Enter the dates you’d like to audit User Logins between using the FromDate and ToDate fields.
NOTE: Dates follow UTC format and will take the hours and minutes as 00:00 unless specified. To fetch values for a specific date, either specify the time or use the following date. For example, to fetch values for 11/1/2023, use either 2023-11-01T23:59Z or 202311-02.
The pageSize and pageNumber fields are required and configure the formatting for the returned results. pageSize indicates the number of items returned per page, and pageNumber dictates the current page number.
Execute the method to view matching results, which display in the Response body field. There are options to (A) Copy this to your clipboard, or (B) Download the response body.
EmailService API
Mail/api/getmail
Search the email inbox and return the information requested in the query.
Parameters
{
"hasWords": [
"string"
],
"from": [
"string"
],
"to": [
"string"
],
"dateFrom": "2024-04-09T16:07:35.291Z",
"dateTo": "2024-04-09T16:07:35.291Z",
"hasAttachment": true
}
Output
[
{
"id": "Random Text",
"from": "email",
"to": "email",
"cc": null,
Audit Methods
"bcc": null,
"subject": "test",
"shortBody": "html code",
"body": "html code",
"receivedDateTime": "2023-12-04T22:27:28",
"hasAttachments": false,
"attachments": "plus.png"
},
Mail/api/getmailcontent
Search the email inbox and return the requested information in the query in MIME format.
Parameters
{
"mailId": [
Audit Methods
"string"
]
Output
[“HTML MIME format”]
EntityRecognition API
Comprehend/api/detectentities
Perform a Named Entity Recognition (NER) process using AWS Comprehend according to the specified language and entity type for the requested text
Parameters
lang: Text language
EntityType: Name entities, PII or both
Output
{"Entities":[
{"BeginOffset":0, initial position
"EndOffset":13 final position
,"Score":0.9925614 score from aws
,"Text":"test", text reviewed
"Type":{"Value":"OTHER"}}] name entity
}
Comprehend/api/detectentities
Perform a Named Entity Recognition (NER) process using Core NLP according to the specified language and entity type for the requested text.
Parameters
lang: Text language
Output
{
"sentences": [
{
"index": 0,
"entitymentions": [
{
"docTokenBegin": 0, token start position
"docTokenEnd": 1, token end position
"tokenBegin": 0, token start position
"tokenEnd": 1, token end position
"text": "Yesterday", text reviewed
"characterOffsetBegin": 0, token start position
"characterOffsetEnd": 9, token end position
"ner": "DATE", name entity
"normalizedNER": "OFFSET P-1D",
"nerConfidences": {
"DATE": -1 name entity confidence
}}
MediaRedactions API
Mediaredactions/apiex/mediafile/getsignedurl
Obtains a signed URL which will be used to download a media file.
Parameters
{
"uniqueId": "string",
"folderId": 0,
"reviewLayerId": 0,
"pageId": 0,
"createdBy": 0,
"createdDate": "2024-04-09T16:11:28.623Z",
"declassInfo": "string",
"reviewLayerName": "string",
"tokenHash": "string",
"downLoadedFilePath": "string"
}
Output: string text
Mediaredactions/apiex/mediafile/getsignedurl/sig nedToken
Retrieves the file with the signed URL obtained from the getSignedUrl method
Parameters
signedToken :URL obtained from the getSignedUrl method to get a file
Audit Methods
Output
Reports API
Report/api/isaccuratexml
Checks if the user's XML has a valid format for the annual report submission.
Parameters
XML file
Output
{
"accurate": true, if is accurate
"differencesCount": 0, differences count
"differences": null list of differences
}
