POST api/v{version}/clients/bulk

Gets basic information about a collection of clients in bulk by querying the parastransit database directly.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

The requested API version

 string

Required

Default value is 2.0

Body Parameters

The bulk client request containing information about the clients to be searched for.

BulkClientRequest
NameDescriptionTypeAdditional information
ClientIds

The client Ids to get information about.

 Collection of integer

None.
ClientCodes

The client codes to get information about. Will only be used if no Client Ids are specified.

 Collection of string

None.

Request Formats

application/json, text/json, application/problem+json

Sample: 
{
  "clientIds": [
    1,
    2
  ],
  "clientCodes": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<BulkClientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <ClientCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ClientCodes>
  <ClientIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ClientIds>
</BulkClientRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns basic details about a collection of clients.

Collection of BulkClientInfo
NameDescriptionTypeAdditional information
Id

The client Id.

 integer

None.
Code

The client code.

 string

None.
FirstName

The client's first name.

 string

None.
LastName

The client's last name.

 string

None.
BirthDate

The client's birth date.

 date

None.

Response Formats

application/json, text/json, application/problem+json

Sample: 
[
  {
    "id": 1,
    "code": "sample string 2",
    "firstName": "sample string 3",
    "lastName": "sample string 4",
    "birthDate": "2026-07-17"
  },
  {
    "id": 1,
    "code": "sample string 2",
    "firstName": "sample string 3",
    "lastName": "sample string 4",
    "birthDate": "2026-07-17"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfBulkClientInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <BulkClientInfo>
    <BirthDate>2026-07-17T14:15:39.0727447-04:00</BirthDate>
    <Code>sample string 2</Code>
    <FirstName>sample string 3</FirstName>
    <Id>1</Id>
    <LastName>sample string 4</LastName>
  </BulkClientInfo>
  <BulkClientInfo>
    <BirthDate>2026-07-17T14:15:39.0727447-04:00</BirthDate>
    <Code>sample string 2</Code>
    <FirstName>sample string 3</FirstName>
    <Id>1</Id>
    <LastName>sample string 4</LastName>
  </BulkClientInfo>
</ArrayOfBulkClientInfo>