NAV

Datanexus API

Models

A response by a member to a request for legal consent

{
  "category": "sms",
  "consent_details": [
    {
      "name": "sms_phone_number",
      "value": "555-867-5309"
    }
  ],
  "consented_at": "2022-01-01T22:01:00Z",
  "id": "123",
  "member_id": "aCeYh",
  "member_response": true
}
Property Description Type Required
category Category string false
consent_details array(ConsentDetail) false
consented_at Date / Time of Consent string false
id Unique identifier string true
member_response boolean false

ConsentDetail

An additional attribute of the Consent

{
  "name": "sms_phone_number",
  "value": "555-867-5309"
}
Property Description Type Required
name Detail name string false
value Detail value string false

ConsentResponse

A single Consent

{
  "category": "sms",
  "consent_details": [
    {
      "name": "sms_phone_number",
      "value": "555-867-5309"
    }
  ],
  "consented_at": "2022-01-01T22:01:00Z",
  "id": "123",
  "member_id": "aCeYh",
  "member_response": "true"
}
Property Description Type Required
data A response by a member to a request for legal consent Consent false

ConsentsResponse

A collection of Consents

Property Description Type Required
data The consents details array(Consent) false

Enrollment

The defined access of a household member to a given benefit Program

{
  "enrolled_at": "2022-01-01T22:01:00Z",
  "enrollment_events": [
    {
      "category": "created",
      "details": {
        "something": "someval"
      },
      "id": 789
    }
  ],
  "expires_at": "2023-01-01T22:01:00Z",
  "id": 345,
  "member_id": "AcEyH",
  "program_id": 234
}
Property Description Type Required
enrolled_at Date/Time of Enrollment string false
enrollment_events Enrollment Events array(EnrollmentEvent) false
expires_at Date/Time when the Enrollment expires string false
member_id Member ID string false
program_id Program ID string false

EnrollmentEvent

An event in the lifecycle of an Enrollment

Property Description Type Required
category Event category string false
details array(EnrollmentEventDetail) false

EnrollmentEventDetail

An additional attribute of the EnrollmentEvent

{
  "name": "something",
  "value": "somevalue"
}
Property Description Type Required
name Detail name string false
value Detail value string false

EnrollmentResponse

A response containing one Enrollment

Property Description Type Required
data The defined access of a household member to a given benefit Program Enrollment false

Member

A Member who accesses healthcare services

{
  "born_on": "1975-05-15",
  "city": "Newport Beach",
  "consents": [],
  "email": "abc@def.ghi",
  "enrollments": [],
  "first_name": "Michael",
  "gender": "M",
  "household": [
    {
      "born_on": "1955-05-15",
      "enrollments": [],
      "first_name": "Michael",
      "id": "B6d8Y",
      "last_name": "Bluth"
    }
  ],
  "id": "A5c7X",
  "last_name": "Bluth",
  "middle_name": "George",
  "phone_number": "9875555550",
  "postal_code": "92658",
  "program_status": "pending",
  "state": "CA",
  "street_address_1": "1 Lucille Lane"
}
Property Description Type Required
born_on Date of birth string false
consents Member consents array(Consent) false
email email address string false
enrollments Member enrollments array(Enrollment) false
first_name First Name string false
gender Gender string false
id Unique identifier string false
last_name Last Name string false
middle_name Middle Name string false
phone_number Phone Number string false
program_status Program Status string false

MemberResponse

A response containing a Member

Property Description Type Required
data A Member who accesses healthcare services Member false

MembersResponse

A response containing multiple Members

Property Description Type Required
data Members details array(member) false

Consent

create consent renders consent when data is valid

POST /api/members/QLayl/consents
accept: application/json
authorization: apikey udyuV0be1wVDrgDJa5UK
content-type: multipart/mixed; boundary=plug_conn_test

{
  "consent": {
    "category": "some category",
    "consent_details": {},
    "consented_at": "2022-12-12T21:25:00Z",
    "member_response": true
  }
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd24uUa8i7Mh8AAEhB
location: /api/members/QLayl/consents/1363

{
  "data": {
    "category": "some category",
    "consent_details": {},
    "consented_at": "2022-12-12T21:25:00Z",
    "id": 1363,
    "member_id": "QLayl",
    "member_response": true
  }
}

create consent creates sms consent with partial data

POST /api/members/MKGK5/consents
accept: application/json
authorization: apikey pG6UF7-pOIeUbWxQJv2M
content-type: multipart/mixed; boundary=plug_conn_test

{
  "consent": {
    "category": "sms",
    "consent_details": {
      "confirmation_code": "abc123"
    }
  }
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd24xeOZGhbIsAAEkB
location: /api/members/MKGK5/consents/1366

{
  "data": {
    "category": "sms",
    "consent_details": {
      "confirmation_code": "abc123"
    },
    "consented_at": null,
    "id": 1366,
    "member_id": "MKGK5",
    "member_response": false
  }
}

create consent renders errors when data is invalid

POST /api/members/7wlmL/consents
accept: application/json
authorization: apikey q_oz18LI2mtVTBFlQW8b
content-type: multipart/mixed; boundary=plug_conn_test

{
  "consent": {
    "category": null,
    "consent_details": null,
    "consented_at": null,
    "member_response": null
  }
}

Response

422
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd24tIgoNsaZ4AAEeh

{
  "errors": {
    "category": [
      "can't be blank"
    ],
    "consent_details": [
      "can't be blank"
    ]
  }
}

Create a Consent for a given Member.

Request

POST /api/members/{member_id}/consents

Parameters

Parameter Description In Type Required Default Example
member_id Member ID path string true
consent consent attributes body Consent false

Responses

Status Description Schema
200 OK ConsentResponse
422 Client Error

delete consent deletes chosen consent

DELETE /api/members/o5kd3/consents/1362
accept: application/json
authorization: apikey kL3AWSDMfIwWSNOMFrA4

Response

204
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd24rpnQ5tQnoAAEbB

Delete a Consent for a given Member.

Request

DELETE /api/members/{member_id}/consents/{consent_id}

Parameters

Parameter Description In Type Required Default Example
member_id Member ID path string true
consent_id Consent ID path string true

Responses

Status Description Schema
203 No Content - Deleted Successfully

update consent updates chosen consent

PUT /api/members/o26WZ/consents/1365
accept: application/json
authorization: apikey 9GRBojA2DB2lrcm5pr3n
content-type: multipart/mixed; boundary=plug_conn_test

{
  "consent": {
    "consented_at": "2024-01-31T09:08:07Z",
    "member_response": true
  }
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd24wFDhdwrJ4AAAdC

{
  "data": {
    "category": "sms",
    "consent_details": {
      "sms_number": "5555555555"
    },
    "consented_at": "2024-01-31T09:08:07Z",
    "id": 1365,
    "member_id": "o26WZ",
    "member_response": true
  }
}

Update data on a Consent

Request

PUT /api/members/{member_id}/consents/{consent_id}

Parameters

Parameter Description In Type Required Default Example
member_id Member ID path string true
consent_id Consent ID path string true
consent Consent attributes body Consent false

Responses

Status Description Schema
200 OK Elixir.ConsentResponse
422 Client Error

Enrollment

Create an enrollment

create enrollment renders enrollment when data is valid

POST /api/members/QdV6d/enrollments
accept: application/json
authorization: apikey jHos4FbG_jLuimNTlRjl
content-type: multipart/mixed; boundary=plug_conn_test

{
  "enrollment": {
    "enrolled_at": "2024-03-13T15:52:35.365801Z",
    "member_id": "QdV6d",
    "program_id": 8370
  }
}

Response

201
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd22Tk7LIkN5QAACoB
location: /api/members/QdV6d/enrollments/3231

{
  "data": {
    "enrolled_at": "2024-03-13T15:52:35.365801Z",
    "expires_at": null,
    "id": 3231,
    "member_id": "QdV6d",
    "program_id": 8370
  }
}

create enrollment renders errors when data is invalid

POST /api/members/Mn85R/enrollments
accept: application/json
authorization: apikey RIJA7SVwnB62Oe5bGtX8
content-type: multipart/mixed; boundary=plug_conn_test

{
  "enrollment": {
    "expires_at": "hello"
  }
}

Response

422
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd22R9CnUG2T0AAClh

{
  "errors": {
    "enrolled_at": [
      "can't be blank"
    ],
    "expires_at": [
      "is invalid"
    ],
    "program_id": [
      "can't be blank"
    ]
  }
}

Create an Enrollment for a given Member.

Request

POST /api/members/{member_id}/enrollments

Parameters

Parameter Description In Type Required Default Example
member_id Member ID path string true
enrollement enrollment attributes body Enrollment false

Responses

Status Description Schema
201 OK EnrollmentResponse
422 Client Error

Delete an enrollment

delete enrollment deletes chosen enrollment

DELETE /api/members/o1b0e/enrollments/3227
accept: application/json
authorization: apikey 6RyydgLbx3mMY9h-imiu

Response

204
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd22Hjqghv5V8AACUh

Delete an Enrollment for a given Member.

Request

DELETE /api/members/{member_id}/enrollments/{enrollment_id}

Parameters

Parameter Description In Type Required Default Example
member_id Member ID path string true
enrollment_id Enrollment ID path string true

Responses

Status Description Schema
203 No Content - Deleted Successfully

Update enrollment

update enrollment renders enrollment when data is valid

PUT /api/members/7ZbOm/enrollments/3228
accept: application/json
authorization: apikey JntSwCFYkPsHUS5ueBfl
content-type: multipart/mixed; boundary=plug_conn_test

{
  "enrollment": {
    "expires_at": "2024-03-13T15:52:33.427005Z"
  }
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd22MQvY6i264AACdB

{
  "data": {
    "enrolled_at": "2022-12-14T22:39:00.000000Z",
    "enrollment_events": [],
    "expires_at": "2024-03-13T15:52:33Z",
    "id": 3228,
    "member_id": "7ZbOm",
    "program_id": 8366
  }
}

update enrollment renders errors when data is invalid

PUT /api/members/MOZN5/enrollments/3230
accept: application/json
authorization: apikey 3VxmjVsCqt9DaZjNx_31
content-type: multipart/mixed; boundary=plug_conn_test

{
  "enrollment": {
    "expires_at": "hello"
  }
}

Response

422
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd22QSi8PZSXIAACjB

{
  "errors": {
    "expires_at": [
      "is invalid"
    ]
  }
}

Update data on an Enrollment.

Request

PUT /api/members/{member_id}/enrollments/{enrollment_id}

Parameters

Parameter Description In Type Required Default Example
member_id Member ID path string true
enrollment_id Enrollment ID path string true
enrollment Enrollment attributes body Enrollment false

Responses

Status Description Schema
200 OK EnrollmentResponse
422 Client Error

Member

List members

index lists all members

GET /api/members
accept: application/json
authorization: apikey nNMrwI9OBM5nEs_ex09p

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zTE9EMV5TAAABFF

{
  "data": [],
  "next_cursor": null,
  "prev_cursor": null
}

index lists pending members

GET /api/members?pending=true&updated_since=2022-01-01T00%3A00%3A00Z
accept: application/json
authorization: apikey h69zEyK4bKBfm0tWdn3l

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zVwKOAfpssAABgB

{
  "data": [
    {
      "born_on": "2000-01-01",
      "city": null,
      "consents": [],
      "eligibility_start_on": "2021-06-07",
      "email": "pending1@pending.pending",
      "enrollments": [],
      "first_name": "Grumpy",
      "gender": "female",
      "health_plan_identifier": null,
      "id": "QdVm0",
      "last_name": "Poppins",
      "middle_name": "",
      "phone_number": null,
      "postal_code": null,
      "prefixed_sponsor_member_identifier": "CFP-GABBAGABBAHEY",
      "program_status": "pending",
      "soda_sponsor_id": null,
      "sponsor_member_identifier": "GABBAGABBAHEY",
      "state": null,
      "street_address_1": null,
      "street_address_2": null
    }
  ],
  "next_cursor": null,
  "prev_cursor": null
}

index lists recently updated members

GET /api/members?updated_since=2022-01-01T00%3A00%3A00Z
accept: application/json
authorization: apikey AR5Xj2c_ABMUqAHfYeL7

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zGmpwdfDd0AABaB

{
  "data": [
    {
      "born_on": "2000-01-01",
      "city": null,
      "consents": [],
      "eligibility_start_on": "2018-01-01",
      "email": "active1@active.active",
      "enrollments": [],
      "first_name": "Alpha",
      "gender": "female",
      "health_plan_identifier": null,
      "id": "7aYyR",
      "last_name": "Poppins",
      "middle_name": "",
      "phone_number": null,
      "postal_code": null,
      "prefixed_sponsor_member_identifier": "PVU-IMMRMEESEEKS",
      "program_status": "active",
      "soda_sponsor_id": null,
      "sponsor_member_identifier": "IMMRMEESEEKS",
      "state": null,
      "street_address_1": null,
      "street_address_2": null
    }
  ],
  "next_cursor": null,
  "prev_cursor": null
}

index lists pending members with pagination

GET /api/members?limit=2&pending=true&updated_since=2022-01-01T00%3A00%3A00Z
accept: application/json
authorization: apikey rouA80lllf3d6oYrG2An

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2yzH1iIwcdAAAA7l
x-next-cursor: g2wAAAABYgABO_Nq

{
  "data": [
    {
      "born_on": "2000-01-01",
      "city": null,
      "consents": [],
      "eligibility_start_on": "2021-06-07",
      "email": "pending1@pending.pending",
      "enrollments": [],
      "first_name": "Bet",
      "gender": "female",
      "health_plan_identifier": null,
      "id": "oRn65",
      "last_name": "Poppins",
      "middle_name": "",
      "phone_number": null,
      "postal_code": null,
      "prefixed_sponsor_member_identifier": "AYE-GABBAGABBAHEY",
      "program_status": "pending",
      "soda_sponsor_id": null,
      "sponsor_member_identifier": "GABBAGABBAHEY",
      "state": null,
      "street_address_1": null,
      "street_address_2": null
    },
    {
      "born_on": "2000-01-01",
      "city": null,
      "consents": [],
      "eligibility_start_on": "2021-06-07",
      "email": "pending2@pending.pending",
      "enrollments": [],
      "first_name": "Gimel",
      "gender": "female",
      "health_plan_identifier": null,
      "id": "74BD4",
      "last_name": "Poppins",
      "middle_name": "",
      "phone_number": null,
      "postal_code": null,
      "prefixed_sponsor_member_identifier": "RQA-PENDING2",
      "program_status": "pending",
      "soda_sponsor_id": null,
      "sponsor_member_identifier": "PENDING2",
      "state": null,
      "street_address_1": null,
      "street_address_2": null
    }
  ],
  "next_cursor": null,
  "prev_cursor": null
}

index lists members by name, birthdate, and program eligibility

GET /api/members?born_on=1976-07-04&first_name=Alexander&include_household=true&last_name=Hamilton&program_id=8355
accept: application/json
authorization: apikey _-n6rl2SXlQ1ZMfw-CKi

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zZa4RcAJiAAAA-E

{
  "data": [
    {
      "born_on": "1976-07-04",
      "city": "Washington",
      "consents": [],
      "eligibility_start_on": "2021-06-07",
      "email": "ahamilton@continentalcongress.gov",
      "enrollments": [],
      "first_name": "Alexander",
      "gender": "male",
      "health_plan_identifier": "HAMILTON01",
      "household_members": [
        {
          "born_on": "1976-07-04",
          "email": "ahamilton@continentalcongress.gov",
          "enrollments": [],
          "first_name": "Alexander",
          "id": "7E8ln",
          "last_name": "Hamilton",
          "program_status": "pending"
        },
        {
          "born_on": "1976-08-04",
          "email": "ehamilton@schuylerhome.org",
          "enrollments": [
            {
              "enrolled_at": "2022-12-14T22:39:00.000000Z",
              "expires_at": "2022-12-14T22:39:00Z",
              "id": 3226,
              "member_id": "7xZm3",
              "program_id": 8355
            }
          ],
          "first_name": "Eliza",
          "id": "7xZm3",
          "last_name": "Hamilton",
          "program_status": "pending"
        }
      ],
      "id": "7E8ln",
      "last_name": "Hamilton",
      "middle_name": "",
      "phone_number": null,
      "postal_code": "10101",
      "prefixed_sponsor_member_identifier": "CYN-HAMILTON01",
      "program_status": "pending",
      "soda_sponsor_id": null,
      "sponsor_member_identifier": "HAMILTON01",
      "state": "DC",
      "street_address_1": "1700 Pennsylvania Ave",
      "street_address_2": null
    }
  ],
  "next_cursor": null,
  "prev_cursor": null
}

Request data on members. This operation supports limited filtering.

Request

GET /api/members

Parameters

Parameter Description In Type Required Default Example
page_size Number of elements per page query integer false
page Number of the page query integer false
born_on Member date of birth (YYYY-MM-DD) query string false
cursor_next Cursor for next group of records query string false
cursor_prev Cursor for previous group of records query string false
first_name Return members with the provided first name query string false
include_household Return member household data query boolean false
last_name Return members with the provided last name query string false
limit Number of records to return query integer false
pending Return only pending members query boolean false
program_id Return members eligible for the specified Program query integer false
updated_since Return records updated since this date (ISO8601 format) query string false

Responses

Status Description Schema
200 OK MembersResponse

Show member

show member shows a member

GET /api/members/7ZbA6
accept: application/json
authorization: apikey uJlQXyCoHVKAeSH7pvuO

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zLm6TEC5NQAAA_l

{
  "data": {
    "born_on": "2000-01-01",
    "city": null,
    "consents": [
      {
        "category": "sms",
        "consent_details": {
          "sms_number": "5555555555"
        },
        "consented_at": "2022-12-12T12:12:12Z",
        "id": 1360,
        "member_id": "7ZbA6",
        "member_response": true
      },
      {
        "category": "hipaa",
        "consent_details": {
          "sms_number": "5555555555"
        },
        "consented_at": "2022-12-13T12:12:12Z",
        "id": 1361,
        "member_id": "7ZbA6",
        "member_response": true
      }
    ],
    "eligibility_start_on": "2018-01-01",
    "email": "myemail@myplace.xyz",
    "enrollments": [],
    "first_name": "Emmanuel",
    "gender": "female",
    "health_plan_identifier": null,
    "id": "7ZbA6",
    "last_name": "Kant",
    "middle_name": "",
    "phone_number": null,
    "postal_code": null,
    "prefixed_sponsor_member_identifier": "GFC-COGITO55",
    "program_status": "pending",
    "soda_sponsor_id": "SODAID12345",
    "sponsor_member_identifier": "COGITO55",
    "state": null,
    "street_address_1": null,
    "street_address_2": null
  }
}

show member shows an inactive member

GET /api/members/ommXk
accept: application/json
authorization: apikey fTYgWYq8_-kcz_tuXQr9

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2yqPIUSmj9AAAA4F

{
  "data": {
    "born_on": "2000-01-01",
    "city": null,
    "consents": [
      {
        "category": "sms",
        "consent_details": {
          "sms_number": "5555555555"
        },
        "consented_at": "2022-12-12T12:12:12Z",
        "id": 1358,
        "member_id": "ommXk",
        "member_response": true
      },
      {
        "category": "hipaa",
        "consent_details": {
          "sms_number": "5555555555"
        },
        "consented_at": "2022-12-13T12:12:12Z",
        "id": 1359,
        "member_id": "ommXk",
        "member_response": true
      }
    ],
    "eligibility_start_on": null,
    "email": "myemail@myplace.xyz",
    "enrollments": [],
    "first_name": "Karl",
    "gender": "female",
    "health_plan_identifier": null,
    "id": "ommXk",
    "last_name": "Marx",
    "middle_name": "",
    "phone_number": null,
    "postal_code": null,
    "prefixed_sponsor_member_identifier": "CTE-MEANSOF789",
    "program_status": "inactive",
    "soda_sponsor_id": "",
    "sponsor_member_identifier": null,
    "state": null,
    "street_address_1": null,
    "street_address_2": null
  }
}

show member shows a member by prefixed sponsor_member_identifier

GET /api/members/EOE-COGITO55
accept: application/json
authorization: apikey IcadUXlkMwEdjy6wf_dI

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2yspftiE9H8AAArk

{
  "data": {
    "born_on": "2000-01-01",
    "city": null,
    "consents": [],
    "eligibility_start_on": "2018-01-01",
    "email": "myemail@myplace.xyz",
    "enrollments": [],
    "first_name": "Emmanuel",
    "gender": "female",
    "health_plan_identifier": null,
    "id": "o8YAO",
    "last_name": "Kant",
    "middle_name": "",
    "phone_number": null,
    "postal_code": null,
    "prefixed_sponsor_member_identifier": "EOE-COGITO55",
    "program_status": "pending",
    "soda_sponsor_id": "SODAID12345",
    "sponsor_member_identifier": "COGITO55",
    "state": null,
    "street_address_1": null,
    "street_address_2": null
  }
}

show member shows an accessible member to a non-admin

GET /api/members/Mk9Pw
accept: application/json
authorization: apikey 6veFFJ_RpfvOw-I6bP3t

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2y6Zj-FAZw4AABWh

{
  "data": {
    "born_on": "2000-01-01",
    "city": null,
    "consents": [],
    "eligibility_start_on": "2018-01-01",
    "email": "myemail@myplace.xyz",
    "enrollments": [],
    "first_name": "Emmanuel",
    "gender": "female",
    "health_plan_identifier": null,
    "id": "Mk9Pw",
    "last_name": "Kant",
    "middle_name": "",
    "phone_number": null,
    "postal_code": null,
    "prefixed_sponsor_member_identifier": "EUW-COGITO55",
    "program_status": "pending",
    "soda_sponsor_id": "SODAID12345",
    "sponsor_member_identifier": "COGITO55",
    "state": null,
    "street_address_1": null,
    "street_address_2": null
  }
}

show member includes vendor data when present and accessible

GET /api/members/MOZ0p
accept: application/json
authorization: apikey tXSkbmRDgPJKmgMmhBG4

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zRlDc6rG_wAAA6k

{
  "data": {
    "born_on": "2000-01-01",
    "city": null,
    "consents": [],
    "eligibility_start_on": "2018-01-01",
    "email": "myemail@myplace.xyz",
    "enrollments": [],
    "first_name": "Emmanuel",
    "gender": "female",
    "health_plan_identifier": null,
    "id": "MOZ0p",
    "last_name": "Kant",
    "middle_name": "",
    "phone_number": null,
    "postal_code": null,
    "prefixed_sponsor_member_identifier": "MGE-COGITO55",
    "program_status": "pending",
    "soda_sponsor_id": "SODAID12345",
    "sponsor_member_identifier": "COGITO55",
    "state": null,
    "street_address_1": null,
    "street_address_2": null,
    "vendor_data": [
      {
        "payment_card_status": "requested"
      }
    ]
  }
}

show member does not include vendor data for non-vendor users

GET /api/members/MjymW
accept: application/json
authorization: apikey nC37KvMB1FzVtTpbV-L_

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2y-wOE77sk4AAAwk

{
  "data": {
    "born_on": "2000-01-01",
    "city": null,
    "consents": [],
    "eligibility_start_on": "2018-01-01",
    "email": "myemail@myplace.xyz",
    "enrollments": [],
    "first_name": "Emmanuel",
    "gender": "female",
    "health_plan_identifier": null,
    "id": "MjymW",
    "last_name": "Kant",
    "middle_name": "",
    "phone_number": null,
    "postal_code": null,
    "prefixed_sponsor_member_identifier": "ITG-COGITO55",
    "program_status": "pending",
    "soda_sponsor_id": "SODAID12345",
    "sponsor_member_identifier": "COGITO55",
    "state": null,
    "street_address_1": null,
    "street_address_2": null
  }
}

Request data on a member.

Request

GET /api/members/{member_id}

Parameters

Parameter Description In Type Required Default Example
member_id Member ID path string true

Responses

Status Description Schema
200 OK MemberResponse

Update member

update member renders member when data is valid

PUT /api/members/olNmR
accept: application/json
authorization: apikey 7mBkJKKCdwWY5QWpNGSj
content-type: multipart/mixed; boundary=plug_conn_test

{
  "member": {
    "born_on": "2002-01-01",
    "email": "newemail@newplace.xyz",
    "first_name": "some updated first_name",
    "last_name": "some updated last_name",
    "middle_name": "some updated middle_name"
  }
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zI8aETtJtwAABdB

{
  "data": {
    "born_on": "2002-01-01",
    "city": null,
    "consents": [],
    "eligibility_start_on": "2018-01-01",
    "email": "newemail@newplace.xyz",
    "enrollments": [],
    "first_name": "some updated first_name",
    "gender": "female",
    "health_plan_identifier": null,
    "id": "olNmR",
    "last_name": "some updated last_name",
    "middle_name": "some updated middle_name",
    "phone_number": null,
    "postal_code": null,
    "prefixed_sponsor_member_identifier": "NYU-COGITO55",
    "program_status": "pending",
    "soda_sponsor_id": null,
    "sponsor_member_identifier": "COGITO55",
    "state": null,
    "street_address_1": null,
    "street_address_2": null
  }
}

update member renders errors when data is invalid

PUT /api/members/o1bgR
accept: application/json
authorization: apikey iPG0qGOakprloxTECQ-f
content-type: multipart/mixed; boundary=plug_conn_test

{
  "member": {
    "born_on": null,
    "email": null,
    "first_name": null,
    "gender": "hello",
    "last_name": null
  }
}

Response

422
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zhrpDZlqPkAABGk

{
  "errors": {
    "born_on": [
      "can't be blank"
    ],
    "first_name": [
      "can't be blank"
    ],
    "gender": [
      "is invalid"
    ],
    "last_name": [
      "can't be blank"
    ]
  }
}

update member accepts vendor-specific member attributes

PUT /api/members/oGRWv
accept: application/json
authorization: apikey 30VeGt3MeAz46_yd0aDb
content-type: multipart/mixed; boundary=plug_conn_test

{
  "member": {
    "vendor_data": {
      "my_test_attribute": "excelsior"
    }
  }
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zCrcHtmonIAAA1E

{
  "data": {
    "born_on": "2000-01-01",
    "city": null,
    "consents": [],
    "eligibility_start_on": "2018-01-01",
    "email": "myemail@myplace.xyz",
    "enrollments": [],
    "first_name": "Emmanuel",
    "gender": "female",
    "health_plan_identifier": null,
    "id": "oGRWv",
    "last_name": "Kant",
    "middle_name": "",
    "phone_number": null,
    "postal_code": null,
    "prefixed_sponsor_member_identifier": "MIO-COGITO55",
    "program_status": "pending",
    "soda_sponsor_id": null,
    "sponsor_member_identifier": "COGITO55",
    "state": null,
    "street_address_1": null,
    "street_address_2": null
  }
}

update member allows clearing of member fields

PUT /api/members/QWqJn
accept: application/json
authorization: apikey NYBoMu9Yjnm3JyAkXz9R
content-type: multipart/mixed; boundary=plug_conn_test

{
  "member": {
    "street_address_2": null
  }
}

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd2zNrVuMJlUgAABCF

{
  "data": {
    "born_on": "2000-01-01",
    "city": null,
    "consents": [],
    "eligibility_start_on": "2018-01-01",
    "email": "myemail@myplace.xyz",
    "enrollments": [],
    "first_name": "Emmanuel",
    "gender": "female",
    "health_plan_identifier": null,
    "id": "QWqJn",
    "last_name": "Kant",
    "middle_name": "",
    "phone_number": null,
    "postal_code": null,
    "prefixed_sponsor_member_identifier": "EPA-COGITO55",
    "program_status": "pending",
    "soda_sponsor_id": null,
    "sponsor_member_identifier": "COGITO55",
    "state": null,
    "street_address_1": null,
    "street_address_2": null
  }
}

Update data on a Member.

Request

PUT /api/members/{member_id}

Parameters

Parameter Description In Type Required Default Example
member_id Member ID path string true
member Member attributes body Member false

Responses

Status Description Schema
200 OK MemberResponse

Ping

index gets a 200 response if authenticated

GET /api/pings
accept: application/json
authorization: apikey XG31lbLeUSzSq3ywNRkS

Response

200
content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate
x-request-id: F7xd24IFdeg4_yQAADrh

{
  "data": [
    {
      "response": "pong"
    }
  ]
}

request a test response

Request

GET /pings

Responses

Status Description Schema
200 response: pong