jobStatus

jobStatus

GET

/{businessLine}/status/{key}

Returns the status of the job request, such as queued, running or complete.

Prod:
https://api.seic.com/v1/jobs/{businessLine}/status/{key}
Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

Path Parameters
Name Description Data Type Required
businessLine

This parameter defines the business line the job belongs to. Valid value is endClientReporting

string

key

This value is returned by the POST schedule API in the response as "jobStatusQueryKey".

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections.

  • 500

    Internal Server Error - The server was unable to fulfill the request

TEST ENDPOINT
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

businessLine This parameter defines the business line the job belongs to. Valid value is endClientReporting true

key This value is returned by the POST schedule API in the response as "jobStatusQueryKey". true

HTTP Basic

OAuth 2.0

API Key

Working...

jobStatus

jobStatus

GET

/{businessLine}/status/{key}

Returns the status of the job request, such as queued, running or complete.

Prod:
https://api.seic.com/v1/jobs/{businessLine}/status/{key}
Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

Path Parameters
Name Description Data Type Required
businessLine

This parameter defines the business line the job belongs to. Valid value is endClientReporting

string

key

This value is returned by the POST schedule API in the response as "jobStatusQueryKey".

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections.

  • 500

    Internal Server Error - The server was unable to fulfill the request

TEST ENDPOINT
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

businessLine This parameter defines the business line the job belongs to. Valid value is endClientReporting true

key This value is returned by the POST schedule API in the response as "jobStatusQueryKey". true

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v1/jobs/{businessLine}/status/{key}
TLS*: https://mtls.api.seic.com/v1/jobs/{businessLine}/status/{key}
*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

Pass the oAuth Token and the App key to invoke this endpoint for a particular application.

jobStatus

jobStatus

GET

/{businessLine}/status/{key}

Returns the status of the job request, such as queued, running or complete.

Prod:
https://api.seic.com/v1/jobs/{businessLine}/status/{key}
Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

Path Parameters
Name Description Data Type Required
businessLine

This parameter defines the business line the job belongs to. Valid value is endClientReporting

string

key

This value is returned by the POST schedule API in the response as "jobStatusQueryKey".

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections.

  • 500

    Internal Server Error - The server was unable to fulfill the request

TEST ENDPOINT
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

businessLine This parameter defines the business line the job belongs to. Valid value is endClientReporting true

key This value is returned by the POST schedule API in the response as "jobStatusQueryKey". true

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X GET \
   https://api.seic.com/v1/jobs/endClientReporting/status/NC8yMi8xOSAyMzoyMzo1OQ== \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN'


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
RESPONSE HEADER

Content-Type: application/json 
Status: 200 OK 
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9


SAMPLE RESPONSE

{
    "data": {
        "jobStatus": "Running",
        "BatchId": "23150"
    }
}
MODEL
Operations
Name Description Data Type (L)
jobStatus

The status of the job scheduled. Valid values are Queuing,error, completed and running

string
batchId

SEI Accounting system generated identifier for batch representing a group of journal entries

string


jobStatus

jobStatus

GET

/{businessLine}/status/{key}

Returns the status of the job request, such as queued, running or complete.

Prod:
https://api.seic.com/v1/jobs/{businessLine}/status/{key}
Header Parameters
Name Description Data Type Required
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

string

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

string

Path Parameters
Name Description Data Type Required
businessLine

This parameter defines the business line the job belongs to. Valid value is endClientReporting

string

key

This value is returned by the POST schedule API in the response as "jobStatusQueryKey".

string

HTTP Responses
  • Code
    Description
  • 200

    OK- The request has succeeded and the response has been returned.

  • 400

    Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.

  • 401

    Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.

  • 403

    Forbidden-The SEI Server understood the request but refuses to fulfill it.

  • 404

    Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections.

  • 500

    Internal Server Error - The server was unable to fulfill the request

TEST ENDPOINT
Authorization

access_token value obtained from the Token endpoint.This is passed as "Bearer access_token"

AppKey

This is the Consumer Key provided during the App Registration process and is used to identify the user's application.

Request Body

businessLine This parameter defines the business line the job belongs to. Valid value is endClientReporting true

key This value is returned by the POST schedule API in the response as "jobStatusQueryKey". true

HTTP Basic

OAuth 2.0

API Key

Working...