POST CorporateCards

Adds a CorporateCard.


Parameters

NameDescriptionAdditional information
request
The CorporateCard to add.
            When adding a new CorporateCard through the API, the following properties are required: 
            Id: Must be set to 0, or the add will throw an error.
            Label: Must be set to something meaningful, or the add will throw an error.
            EmployeeId: The Id of the Employee to link as the budget holder.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "Id": 1,
  "EmployeeId": 2,
  "CardType": 1,
  "CardProviderId": 3,
  "CardNumber": "sample string 4",
  "IsActive": true
}

application/xml, text/xml

Sample:
<CorporateCard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types.Employees">
  <CardNumber>sample string 4</CardNumber>
  <CardProviderId>3</CardProviderId>
  <CardType>CreditCard</CardType>
  <EmployeeId>2</EmployeeId>
  <Id>1</Id>
  <IsActive>true</IsActive>
</CorporateCard>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

A CorporateCardResponse.

application/json, text/json

Sample:
{
  "Item": {
    "Id": 1,
    "EmployeeId": 2,
    "CardType": 1,
    "CardProviderId": 3,
    "CardNumber": "sample string 4",
    "IsActive": true
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<CorporateCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types.Employees" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:CardNumber>sample string 4</d2p1:CardNumber>
    <d2p1:CardProviderId>3</d2p1:CardProviderId>
    <d2p1:CardType>CreditCard</d2p1:CardType>
    <d2p1:EmployeeId>2</d2p1:EmployeeId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsActive>true</d2p1:IsActive>
  </Item>
</CorporateCardResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body