POST api/BatchStatus

Create a batch request for determination information.

Request Information

URI Parameters

None.

Body Parameters

Collection of NCSIScreen
NameDescriptionTypeAdditional information
NGB

National Governing Body or sport the requested individual with which the requested individual is associated

string

Required

Max length: 150

FirstName

First Name

string

Required

Max length: 100

LastName

Last Name

string

Required

Max length: 100

MiddleName

Middle name or initial, if available

string

Max length: 50

EmailAddress

EMail Address

string

Required

Max length: 150

DateOfBirth

Date of Birth (MM/DD/YYYY)

string

Required

Max length: 10

UniqueId

Unique Identifier (Eg. Salesforce ID) that will be used to tie the result back to source record

string

Required

Max length: 255

FileNumber

File Number, if available

BigInteger

None.

Reference1

Reference 1, if there are other identifiers available

string

Max length: 150

Reference2

Reference 2, if there are other identifiers available

string

Max length: 150

Reference3

Reference 3, if there are other identifiers available

string

Max length: 150

Request Formats

application/json, text/json

Sample:
[
  {
    "NGB": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "MiddleName": "sample string 4",
    "EmailAddress": "sample string 5",
    "DateOfBirth": "12/6/2025",
    "UniqueId": "sample string 8",
    "FileNumber": 0,
    "Reference1": "sample string 9",
    "Reference2": "sample string 10",
    "Reference3": "sample string 11"
  },
  {
    "NGB": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "MiddleName": "sample string 4",
    "EmailAddress": "sample string 5",
    "DateOfBirth": "12/6/2025",
    "UniqueId": "sample string 8",
    "FileNumber": 0,
    "Reference1": "sample string 9",
    "Reference2": "sample string 10",
    "Reference3": "sample string 11"
  }
]

application/xml, text/xml

Sample:
<ArrayOfNCSIScreen xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCSI.API.ViewModels">
  <NCSIScreen>
    <DateOfBirth>12/6/2025</DateOfBirth>
    <DateOfBirthDt>2025-12-06T00:18:07.6036854-05:00</DateOfBirthDt>
    <EmailAddress>sample string 5</EmailAddress>
    <FileNumber xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Numerics">
      <d3p1:_bits xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d3p1:_sign>0</d3p1:_sign>
    </FileNumber>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <MiddleName>sample string 4</MiddleName>
    <NGB>sample string 1</NGB>
    <Reference1>sample string 9</Reference1>
    <Reference2>sample string 10</Reference2>
    <Reference3>sample string 11</Reference3>
    <UniqueId>sample string 8</UniqueId>
  </NCSIScreen>
  <NCSIScreen>
    <DateOfBirth>12/6/2025</DateOfBirth>
    <DateOfBirthDt>2025-12-06T00:18:07.6036854-05:00</DateOfBirthDt>
    <EmailAddress>sample string 5</EmailAddress>
    <FileNumber xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Numerics">
      <d3p1:_bits xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d3p1:_sign>0</d3p1:_sign>
    </FileNumber>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <MiddleName>sample string 4</MiddleName>
    <NGB>sample string 1</NGB>
    <Reference1>sample string 9</Reference1>
    <Reference2>sample string 10</Reference2>
    <Reference3>sample string 11</Reference3>
    <UniqueId>sample string 8</UniqueId>
  </NCSIScreen>
</ArrayOfNCSIScreen>

multipart/form-data

Sample:
<ArrayOfNCSIScreen xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCSI.API.ViewModels"><NCSIScreen><DateOfBirth>12/6/2025</DateOfBirth><DateOfBirthDt>2025-12-06T00:18:07.6036854-05:00</DateOfBirthDt><EmailAddress>sample string 5</EmailAddress><FileNumber xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Numerics"><d3p1:_bits xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /><d3p1:_sign>0</d3p1:_sign></FileNumber><FirstName>sample string 2</FirstName><LastName>sample string 3</LastName><MiddleName>sample string 4</MiddleName><NGB>sample string 1</NGB><Reference1>sample string 9</Reference1><Reference2>sample string 10</Reference2><Reference3>sample string 11</Reference3><UniqueId>sample string 8</UniqueId></NCSIScreen><NCSIScreen><DateOfBirth>12/6/2025</DateOfBirth><DateOfBirthDt>2025-12-06T00:18:07.6036854-05:00</DateOfBirthDt><EmailAddress>sample string 5</EmailAddress><FileNumber xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Numerics"><d3p1:_bits xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /><d3p1:_sign>0</d3p1:_sign></FileNumber><FirstName>sample string 2</FirstName><LastName>sample string 3</LastName><MiddleName>sample string 4</MiddleName><NGB>sample string 1</NGB><Reference1>sample string 9</Reference1><Reference2>sample string 10</Reference2><Reference3>sample string 11</Reference3><UniqueId>sample string 8</UniqueId></NCSIScreen></ArrayOfNCSIScreen>

Response Information

Resource Description

HTTP Status: 200 - OK - Batch accepted. 400 - BadRequest - Unable to process batch 401 - Unauthorized - User not authorized 500 - InternalServerError - Error processing batch

BatchInstance
NameDescriptionTypeAdditional information
Id

Batch Id

globally unique identifier

None.

Status

Batch Status

string

None.

CreatedDate

date

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "6c086449-c4e6-440b-bda0-27c945b0652b",
  "Status": "sample string 2",
  "CreatedDate": "2025-12-06T00:18:07.6036854-05:00",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:
<BatchInstance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCSI.API.ViewModels">
  <CreatedDate>2025-12-06T00:18:07.6036854-05:00</CreatedDate>
  <Id>6c086449-c4e6-440b-bda0-27c945b0652b</Id>
  <Message>sample string 4</Message>
  <Status>sample string 2</Status>
</BatchInstance>

multipart/form-data

Sample:
<BatchInstance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCSI.API.ViewModels"><CreatedDate>2025-12-06T00:18:07.6036854-05:00</CreatedDate><Id>6c086449-c4e6-440b-bda0-27c945b0652b</Id><Message>sample string 4</Message><Status>sample string 2</Status></BatchInstance>