GAgalileo-ft
Alerts

Set Alerts Blackout

Use the Set Alerts Blackout to set customer preferences for when messages should not be sent.

post/setAlertsBlackout

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/setAlertsBlackout
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>.. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring required

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

beginTimestring required

Starting time for alerts to be sent. Set to whole hours only. Pattern: HH:00 Example: "07:00"

endTimestring required

Time of day alerts must end. Set to whole hours only. Pattern: HH:00 Example: "22:00"

timeZone'-3' | '-2' | '-1' | '0' | '1' | '2' | '3' | 'hawaii' | 'alaska' | 'pacific' | 'mountain' | 'central' | 'eastern' | 'atlantic' required

Time zone offset from Arizona time for beginTime and endTime:

  • -3 — Hawaii time zone
  • -2 — Alaska time zone
  • -1 — Pacific time zone
  • 0 — Mountain time zone
  • 1 — Central time zone
  • 2 — Eastern time zone
  • 3 — Atlantic time zone

Pattern: Integer between -3 and 3 Example: -1

daylightSavings'Y' | 'N' required

Specifies whether to observe daylight savings time. Pattern: Y or N Example: "Y"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "beginTime": "07:00",
  "endTime": "22:00",
  "daylightSavings": "Y"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

response_dataobject required

A structure for the response data. This endpoint does not return response data, so it will always be empty.

Changes

No recorded changes to this operation across all 2 revisions of this API.