Safety Net Blueprint — Client Reference: Data Exchange

Services (2)

▶ listServices() You can provide a client instance returned by `createClient()` instead of API ref → #

data-exchange.listServices({
  query: { q?: string, limit?: number, offset?: number, sort?: string, serviceType?: enum },
})

Parameters

q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional
serviceType	enum (12 values)	query	optional

▶ getService(serviceId) Get an external service API ref → #

data-exchange.getService({ path: { serviceId: string } })

Parameters

serviceId

string

path

required

Service Calls (3)

▶ listServiceCalls() List service calls API ref → #

data-exchange.listServiceCalls({
  query: { q?: string, limit?: number, offset?: number, sort?: string, requestingResourceId?: string, serviceType?: enum, status?: enum: },
})

Parameters

q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional
requestingResourceId	string	query	optional
serviceType	enum (12 values)	query	optional
status	enum: "pending", "completed", "failed", "timed_out"	query	optional

▶ createServiceCall() Submit a service call API ref → #

data-exchange.createServiceCall({ body: { ... } })

Parameters

body

object

body

required

▶ getServiceCall(serviceCallId) Get a service call API ref → #

data-exchange.getServiceCall({ path: { serviceCallId: string } })

Parameters

serviceCallId

string

path

required

Metadata (2)

▶ deleteServiceCallMetadata(serviceCallId, domain) Remove domain metadata from a service call API ref → #

data-exchange.deleteServiceCallMetadata({
  path: { serviceCallId: string, domain: enum (6 values) },
})

Parameters

serviceCallId	string	path	required
domain	enum (6 values)	path	required

▶ setServiceCallMetadata(serviceCallId, domain) Set domain metadata on a service call API ref → #

data-exchange.setServiceCallMetadata({
  path: { serviceCallId: string, domain: enum (6 values) },
  body: { ... },
})

Parameters

serviceCallId	string	path	required
domain	enum (6 values)	path	required
body	object	body	required

Constants (3)

▶ CallMode enum (2 values) #

'async'
'sync'

▶ ExternalServiceCallStatus enum (4 values) #

'pending'
'completed'
'failed'
'timed_out'

▶ ServiceType enum (12 values) #

'fdsh_ssa'
'fdsh_vlp'
'fdsh_fti'
'fdsh_medicare'
'fdsh_vci'
'ssa_ievs'
'irs_ievs'
'swica'
'uib'
'save'
'enrollment_check'
'incarceration_check'

Types (6)

▶ ExternalService 8 fields #

interface ExternalService {
  id: string
  name: string
  serviceType: enum (12 values)
  defaultCallMode: enum: "async", "sync"
  programs: array[enum: "snap", "medicaid", "chip", "tanf", "aca"]
  source: enum: "system", "user"
  createdAt: string
  updatedAt: string
}

▶ ExternalServiceList 5 fields #

interface ExternalServiceList {
  items: array[object]
  total: number
  limit: number
  offset: number
  hasNext: boolean
}

▶ ExternalServiceCall 11 fields #

interface ExternalServiceCall {
  id: string
  serviceId: string
  serviceType: enum (12 values)
  requestingResourceId: string
  requestingResourceType?: string
  callMode: enum: "async", "sync"
  status: enum: "pending", "completed", "failed", "timed_out"
  data?: object
  metadata?: object
  createdAt: string
  updatedAt: string
}

▶ ExternalServiceCallList 5 fields #

interface ExternalServiceCallList {
  items: array[object]
  total: number
  limit: number
  offset: number
  hasNext: boolean
}

▶ ExternalServiceWritable 7 fields #

interface ExternalServiceWritable {
  id: string
  name: string
  serviceType: enum (12 values)
  defaultCallMode: enum: "async", "sync"
  programs: array[enum: "snap", "medicaid", "chip", "tanf", "aca"]
  createdAt: string
  updatedAt: string
}

▶ ExternalServiceListWritable 5 fields #

interface ExternalServiceListWritable {
  items: array[object]
  total: number
  limit: number
  offset: number
  hasNext: boolean
}