POST card/batch/participant

Request Information

URI Parameters

None.

Body Parameters

CardSaveParticipantsRequest
NameDescriptionTypeAdditional information
RequestorIdent

string

None.

ProgramIdent

string

None.

Participants

Collection of CardSaveParticipant

None.

Request Formats

application/json, text/json

Sample:
{
  "RequestorIdent": "sample string 1",
  "ProgramIdent": "sample string 2",
  "Participants": [
    {
      "$id": "2",
      "ParticipantIdent": "sample string 1",
      "AccountNbr": "sample string 2",
      "SSN": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "HomePhone": "sample string 6",
      "BusinessPhone": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "City": "sample string 10",
      "State": "sample string 11",
      "Zip": "sample string 12",
      "CountryCode": "sample string 13",
      "EmailAddress": "sample string 14",
      "Hold": "sample string 15",
      "CardStockCode": "sample string 16"
    },
    {
      "$ref": "2"
    }
  ]
}

application/xml, text/xml

Sample:
<CardSaveParticipantsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.EnterpriseServices.Domain.Model.Request">
  <Participants>
    <CardSaveParticipant>
      <AccountNbr>sample string 2</AccountNbr>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <BusinessPhone>sample string 7</BusinessPhone>
      <CardStockCode>sample string 16</CardStockCode>
      <City>sample string 10</City>
      <CountryCode>sample string 13</CountryCode>
      <EmailAddress>sample string 14</EmailAddress>
      <FirstName>sample string 4</FirstName>
      <Hold>sample string 15</Hold>
      <HomePhone>sample string 6</HomePhone>
      <LastName>sample string 5</LastName>
      <ParticipantIdent>sample string 1</ParticipantIdent>
      <SSN>sample string 3</SSN>
      <State>sample string 11</State>
      <Zip>sample string 12</Zip>
    </CardSaveParticipant>
    <CardSaveParticipant>
      <AccountNbr>sample string 2</AccountNbr>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <BusinessPhone>sample string 7</BusinessPhone>
      <CardStockCode>sample string 16</CardStockCode>
      <City>sample string 10</City>
      <CountryCode>sample string 13</CountryCode>
      <EmailAddress>sample string 14</EmailAddress>
      <FirstName>sample string 4</FirstName>
      <Hold>sample string 15</Hold>
      <HomePhone>sample string 6</HomePhone>
      <LastName>sample string 5</LastName>
      <ParticipantIdent>sample string 1</ParticipantIdent>
      <SSN>sample string 3</SSN>
      <State>sample string 11</State>
      <Zip>sample string 12</Zip>
    </CardSaveParticipant>
  </Participants>
  <ProgramIdent>sample string 2</ProgramIdent>
  <RequestorIdent>sample string 1</RequestorIdent>
</CardSaveParticipantsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CardSaveParticipantResponse
NameDescriptionTypeAdditional information
HasErrors

boolean

None.

ParticipantErrors

Collection of CardSaveParticipantError

None.

Response Formats

application/json, text/json

Sample:
{
  "HasErrors": true,
  "ParticipantErrors": [
    {
      "$id": "1",
      "ParticipantIdent": "sample string 1",
      "ErrorMessage": "sample string 2"
    },
    {
      "$ref": "1"
    }
  ]
}

application/xml, text/xml

Sample:
<CardSaveParticipantResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.EnterpriseServices.Domain.Model.Response">
  <HasErrors>true</HasErrors>
  <ParticipantErrors>
    <CardSaveParticipantError>
      <ErrorMessage>sample string 2</ErrorMessage>
      <ParticipantIdent>sample string 1</ParticipantIdent>
    </CardSaveParticipantError>
    <CardSaveParticipantError>
      <ErrorMessage>sample string 2</ErrorMessage>
      <ParticipantIdent>sample string 1</ParticipantIdent>
    </CardSaveParticipantError>
  </ParticipantErrors>
</CardSaveParticipantResponse>