ContractsProviderHibernateImpl Resource

Hibernate implementation of the contracts provider. Created by nick on 4/4/16.

GET /contracts/countContracts

Counts all client contyracts.

Request Parameters
name type description
list query The search list to use.
Response Body
media type data type description
application/json number (JSON) The number of ClientContracts that are associated with the given search list
application/xml long (XML)

Example

Request
GET /contracts/countContracts
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

POST /contracts/expireClientContracts

Expire any contracts that have an expiration date before the provided date.

Request Parameters
name type description
today query The day to expire all contracts before.
Response Body
media type data type description
application/json StatusResponse (JSON) A response as to if the method completed successfully.
application/xml statusResponse (XML)

Example

Request
POST /contracts/expireClientContracts
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "success" : true,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /contracts/getContractTypes

Get all available contract types.

Request Parameters
name type description constraints
airlineId query Optional. Add if you only want types available for a particular airline. long
typeId query Optional. Add if you only want a particlar travel type. 1 = Air, 2 = Car, 3 = Hotel. long
Response Body
media type data type description
application/json array of ContractType (JSON) A list of available contract types for the given parameters.
application/xml list of contractType (XML)

Example

Request
GET /contracts/getContractTypes
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "code" : "...",
  "name" : "...",
  "type" : {
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /contracts/getExpiringClientContractsCount

Gets the count of all expiring/expired ClientContracts of all types, including AirClient, CarClient, etc

Request Parameters
name type description constraints
userId path The user id to get the clients which the user manages long
Response Body
media type data type description
application/json array of Wt0TaskCount (JSON) A list of Wt0TaskCounts
application/xml list of wt0TaskCount (XML)

Example

Request
GET /contracts/getExpiringClientContractsCount
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "count" : 12345,
  "clientId" : 12345,
  "clientName" : "..."
} ]
                
              

GET /contracts/getMidofficeClientContract

Get a contract between a vendor and an account for midoffice purposes.

Request Parameters
name type description constraints
accountnumber query The account number of the account.  
clientId query The Airportal ID. Account number is not necessary if this is available. long
location query The code of the locaiton that holds the contract.  
type query The type of contract. A = Air, H = Hotel, C = Car  
vendor query The code of the vendor that holds the contract.  
Response Body
media type data type description
application/json MidofficeClientContract (JSON) The current contract that is active for this account.
application/xml midofficeClientContract (XML)

Example

Request
GET /contracts/getMidofficeClientContract
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "type" : "...",
  "vendorCode" : "...",
  "tourCode" : "...",
  "corporateIdentifier" : "...",
  "billingIdentifier" : "...",
  "supplementalInstructions" : "...",
  "propertyCode" : "...",
  "override" : true,
  "endorsement" : "...",
  "specialFee" : true,
  "commissionable" : true,
  "preferred" : true,
  "contractType" : "...",
  "designator" : "..."
}
                
              

DELETE /contracts/removeAirContract

Remove a AirContract from a client.

Request Parameters
name type description constraints
comment query  
contract_id query The contract id of the client contract to remove. long
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean

Example

Request
DELETE /contracts/removeAirContract
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

DELETE /contracts/removeCarContract

Remove a CarContract from a client.

Request Parameters
name type description constraints
comment query  
contract_id query The contract id of the client contract to remove. long
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean

Example

Request
DELETE /contracts/removeCarContract
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

DELETE /contracts/removeContract

Remove a contract from a client.

Request Parameters
name type description constraints
comment query  
contract_id query The contract id of the client contract to remove. long
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean

Example

Request
DELETE /contracts/removeContract
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

DELETE /contracts/removeHotelChainContract

Remove a HotelChainContract from a client.

Request Parameters
name type description constraints
comment query  
contract_id query The contract id of the client contract to remove. long
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean

Example

Request
DELETE /contracts/removeHotelChainContract
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

DELETE /contracts/removeHotelContract

Remove a HotelContract from a client.

Request Parameters
name type description constraints
comment query  
contract_id query The contract id of the client contract to remove. long
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean

Example

Request
DELETE /contracts/removeHotelContract
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /contracts/searchContracts

Searches all client contracts.

Request Parameters
name type description
list query The search list to use.
Response Body
media type data type description
application/json array of ClientContract (JSON) A list of ClientContracts that are associated with the given search list
application/xml list of clientContract (XML)

Example

Request
GET /contracts/searchContracts
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "favorite" : true,
  "expirationDate" : 12345,
  "type" : "...",
  "contractLocation" : "...",
  "travelType" : {
    "travelType" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ignored" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

POST /contracts/updateAirClientContract

A function to update air client vendor contracts.

Request Parameters
name type description constraints
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean
Request Body
media type data type description
application/json AirClientContract (JSON) The contract to update
application/xml airClientContract (XML)
Response Body
media type data type description
application/json AirClientContract (JSON) AirClientContract object with violations if did not update/create properly.
application/xml airClientContract (XML)

Example

Request
POST /contracts/updateAirClientContract
Content-Type: application/json
Accept: application/json

                
{
  "expirationDate" : 12345,
  "type" : {
    "name" : "...",
    "type" : {
      "code" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "airline" : {
      "airlineNumber" : 12345,
      "checkinLink" : "...",
      "baggageLink" : "...",
      "alliance" : { },
      "lowCostCarrier" : true,
      "longCode" : "...",
      "manualTicketingOnly" : true,
      "airTicketsUseOrigIssueDate" : true,
      "mcoTicketsUseOrigIssueDate" : true,
      "minDomesticValue" : 12345,
      "minIntlValue" : 12345,
      "position" : 12345,
      "imageUrl" : "...",
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "fileLocation" : "...",
  "vendor" : {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "tourCode" : "...",
  "favorite" : true,
  "serviceInfo" : "...",
  "endorsement" : "...",
  "ticketDesignator" : "...",
  "specialFee" : true,
  "securate" : "...",
  "tmcCommissionable" : true,
  "ignored" : true,
  "contactName" : "...",
  "contactPhone" : "...",
  "ext" : "...",
  "contactEmail" : "...",
  "appliesToAlliance" : true,
  "contractUrls" : [ {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "partners" : [ {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "expirationDate" : 12345,
  "type" : {
    "name" : "...",
    "type" : {
      "code" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "airline" : {
      "airlineNumber" : 12345,
      "checkinLink" : "...",
      "baggageLink" : "...",
      "alliance" : { },
      "lowCostCarrier" : true,
      "longCode" : "...",
      "manualTicketingOnly" : true,
      "airTicketsUseOrigIssueDate" : true,
      "mcoTicketsUseOrigIssueDate" : true,
      "minDomesticValue" : 12345,
      "minIntlValue" : 12345,
      "position" : 12345,
      "imageUrl" : "...",
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "fileLocation" : "...",
  "vendor" : {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "tourCode" : "...",
  "favorite" : true,
  "serviceInfo" : "...",
  "endorsement" : "...",
  "ticketDesignator" : "...",
  "specialFee" : true,
  "securate" : "...",
  "tmcCommissionable" : true,
  "ignored" : true,
  "contactName" : "...",
  "contactPhone" : "...",
  "ext" : "...",
  "contactEmail" : "...",
  "appliesToAlliance" : true,
  "contractUrls" : [ {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "partners" : [ {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /contracts/updateCarClientContract

A function to update car client vendor contracts.

Request Parameters
name type description constraints
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean
Request Body
media type data type description
application/json CarClientContract (JSON) The contract to update
application/xml carClientContract (XML)
Response Body
media type data type description
application/json CarClientContract (JSON) CarClientContract object with violations if did not update/create properly.
application/xml carClientContract (XML)

Example

Request
POST /contracts/updateCarClientContract
Content-Type: application/json
Accept: application/json

                
{
  "vendor" : {
    "longCode" : "...",
    "commissionRate" : 12345.0,
    "position" : 12345,
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "billingId" : "...",
  "insuranceIncluded" : true,
  "fileLocation" : "...",
  "favorite" : true,
  "supplementalInstructions" : "...",
  "billingIsCorpDiscount" : true,
  "ignored" : true,
  "override" : true,
  "contactName" : "...",
  "ext" : "...",
  "contactPhone" : "...",
  "contactEmail" : "...",
  "contractUrls" : [ {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "vendor" : {
    "longCode" : "...",
    "commissionRate" : 12345.0,
    "position" : 12345,
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "billingId" : "...",
  "insuranceIncluded" : true,
  "fileLocation" : "...",
  "favorite" : true,
  "supplementalInstructions" : "...",
  "billingIsCorpDiscount" : true,
  "ignored" : true,
  "override" : true,
  "contactName" : "...",
  "ext" : "...",
  "contactPhone" : "...",
  "contactEmail" : "...",
  "contractUrls" : [ {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /contracts/updateClientcontract

A function to update/create client vendor contracts.

Request Parameters
name type description constraints
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean
Request Body
media type data type description
application/json ClientContract (JSON) The contract to update
application/xml clientContract (XML)
Response Body
media type data type description
application/json ClientContract (JSON) ClientContract object with violations if it did not update/create properly
application/xml clientContract (XML)

Example

Request
POST /contracts/updateClientcontract
Content-Type: application/json
Accept: application/json

                
{
  "favorite" : true,
  "expirationDate" : 12345,
  "type" : "...",
  "contractLocation" : "...",
  "travelType" : {
    "travelType" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ignored" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "favorite" : true,
  "expirationDate" : 12345,
  "type" : "...",
  "contractLocation" : "...",
  "travelType" : {
    "travelType" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ignored" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /contracts/updateContractAirType

Create or Update the Contract Air Type

Request Body
media type data type
application/json ContractAirType (JSON)
application/xml contractAirType (XML)
Response Body
media type data type description
application/json ContractAirType (JSON)
application/xml contractAirType (XML)

Example

Request
POST /contracts/updateContractAirType
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "type" : {
    "code" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "airline" : {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "type" : {
    "code" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "airline" : {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /contracts/updateHotelChainClientContract

A function to update hotel chain client vendor contracts.

Request Parameters
name type description constraints
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean
Request Body
media type data type description
application/json HotelChainClientContract (JSON) The contract to update
application/xml hotelChainClientContract (XML)
Response Body
media type data type description
application/json HotelChainClientContract (JSON) HotelChainClient object with violations if did not update/create properly.
application/xml hotelChainClientContract (XML)

Example

Request
POST /contracts/updateHotelChainClientContract
Content-Type: application/json
Accept: application/json

                
{
  "vendor" : {
    "longCode" : "...",
    "commissionRate" : 12345.0,
    "family" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "position" : 12345,
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "favorite" : true,
  "family" : true,
  "code" : "...",
  "type" : "...",
  "fileLocation" : "...",
  "expirationDate" : 12345,
  "ignored" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "vendor" : {
    "longCode" : "...",
    "commissionRate" : 12345.0,
    "family" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "position" : 12345,
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "favorite" : true,
  "family" : true,
  "code" : "...",
  "type" : "...",
  "fileLocation" : "...",
  "expirationDate" : 12345,
  "ignored" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /contracts/updateHotelClientContract

A function to update hotel client vendor contracts.

Request Parameters
name type description constraints
createTicket query [true|false] if the contract should create a help desk ticket to update the GDS boolean
Request Body
media type data type description
application/json HotelClientContract (JSON) The contract to update
application/xml hotelClientContract (XML)
Response Body
media type data type description
application/json HotelClientContract (JSON) HotelClientContract object with violations if did not update/create properly.
application/xml hotelClientContract (XML)

Example

Request
POST /contracts/updateHotelClientContract
Content-Type: application/json
Accept: application/json

                
{
  "hotel" : {
    "address1" : "...",
    "address2" : "...",
    "phone1" : "...",
    "phone2" : "...",
    "fax" : "...",
    "zip" : "...",
    "city" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "vendor" : {
      "longCode" : "...",
      "commissionRate" : 12345.0,
      "family" : { },
      "position" : 12345,
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "latitude" : 12345.0,
    "sertifiCode" : "...",
    "longitude" : 12345.0,
    "propertyName" : "...",
    "propertyCodes" : [ {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "type" : "...",
  "favorite" : true,
  "expirationDate" : 12345,
  "loadedDate" : 12345,
  "contactName" : "...",
  "contactPhone" : "...",
  "ext" : "...",
  "contactEmail" : "...",
  "fileLocation" : "...",
  "rate" : 12345.0,
  "code" : "...",
  "ignored" : true,
  "supplementalInstructions" : "...",
  "override" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "hotel" : {
    "address1" : "...",
    "address2" : "...",
    "phone1" : "...",
    "phone2" : "...",
    "fax" : "...",
    "zip" : "...",
    "city" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "vendor" : {
      "longCode" : "...",
      "commissionRate" : 12345.0,
      "family" : { },
      "position" : 12345,
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "latitude" : 12345.0,
    "sertifiCode" : "...",
    "longitude" : 12345.0,
    "propertyName" : "...",
    "propertyCodes" : [ {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "type" : "...",
  "favorite" : true,
  "expirationDate" : 12345,
  "loadedDate" : 12345,
  "contactName" : "...",
  "contactPhone" : "...",
  "ext" : "...",
  "contactEmail" : "...",
  "fileLocation" : "...",
  "rate" : 12345.0,
  "code" : "...",
  "ignored" : true,
  "supplementalInstructions" : "...",
  "override" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /contracts/getAirContractById/{contract_id}

Gets the AirClientContract object by it's unique id.

Request Parameters
name type description constraints
contract_id path The contract id of the contract. long
Response Body
media type data type description
application/json AirClientContract (JSON) The AirClientContract object associated by given id
application/xml airClientContract (XML)

Example

Request
GET /contracts/getAirContractById/{contract_id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "expirationDate" : 12345,
  "type" : {
    "name" : "...",
    "type" : {
      "code" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "airline" : {
      "airlineNumber" : 12345,
      "checkinLink" : "...",
      "baggageLink" : "...",
      "alliance" : { },
      "lowCostCarrier" : true,
      "longCode" : "...",
      "manualTicketingOnly" : true,
      "airTicketsUseOrigIssueDate" : true,
      "mcoTicketsUseOrigIssueDate" : true,
      "minDomesticValue" : 12345,
      "minIntlValue" : 12345,
      "position" : 12345,
      "imageUrl" : "...",
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "fileLocation" : "...",
  "vendor" : {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "tourCode" : "...",
  "favorite" : true,
  "serviceInfo" : "...",
  "endorsement" : "...",
  "ticketDesignator" : "...",
  "specialFee" : true,
  "securate" : "...",
  "tmcCommissionable" : true,
  "ignored" : true,
  "contactName" : "...",
  "contactPhone" : "...",
  "ext" : "...",
  "contactEmail" : "...",
  "appliesToAlliance" : true,
  "contractUrls" : [ {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "partners" : [ {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /contracts/getCarContractById/{contract_id}

Gets the CarClientContract object by it's unique id.

Request Parameters
name type description constraints
contract_id path The contract id of the contract. long
Response Body
media type data type description
application/json CarClientContract (JSON) The CarClientContract object associated by given id
application/xml carClientContract (XML)

Example

Request
GET /contracts/getCarContractById/{contract_id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vendor" : {
    "longCode" : "...",
    "commissionRate" : 12345.0,
    "position" : 12345,
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "billingId" : "...",
  "insuranceIncluded" : true,
  "fileLocation" : "...",
  "favorite" : true,
  "supplementalInstructions" : "...",
  "billingIsCorpDiscount" : true,
  "ignored" : true,
  "override" : true,
  "contactName" : "...",
  "ext" : "...",
  "contactPhone" : "...",
  "contactEmail" : "...",
  "contractUrls" : [ {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /contracts/getClientAirContractsById/{clientId}

Gets the AirClientContract objects for this client for air vendor contracts.

Request Parameters
name type description constraints
clientId path The client id to get the ClientContract for. long
Response Body
media type data type description
application/json array of AirClientContract (JSON) A list of AirClientContracts for the given clientId
application/xml list of airClientContract (XML)

Example

Request
GET /contracts/getClientAirContractsById/{clientId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "expirationDate" : 12345,
  "type" : {
    "name" : "...",
    "type" : {
      "code" : "...",
      "name" : "...",
      "type" : { },
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "airline" : {
      "airlineNumber" : 12345,
      "checkinLink" : "...",
      "baggageLink" : "...",
      "alliance" : { },
      "lowCostCarrier" : true,
      "longCode" : "...",
      "manualTicketingOnly" : true,
      "airTicketsUseOrigIssueDate" : true,
      "mcoTicketsUseOrigIssueDate" : true,
      "minDomesticValue" : 12345,
      "minIntlValue" : 12345,
      "position" : 12345,
      "imageUrl" : "...",
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "fileLocation" : "...",
  "vendor" : {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "tourCode" : "...",
  "favorite" : true,
  "serviceInfo" : "...",
  "endorsement" : "...",
  "ticketDesignator" : "...",
  "specialFee" : true,
  "securate" : "...",
  "tmcCommissionable" : true,
  "ignored" : true,
  "contactName" : "...",
  "contactPhone" : "...",
  "ext" : "...",
  "contactEmail" : "...",
  "appliesToAlliance" : true,
  "contractUrls" : [ {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "partners" : [ {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "airlineNumber" : 12345,
    "checkinLink" : "...",
    "baggageLink" : "...",
    "alliance" : {
      "sharesFrequentFlyerNumbers" : true,
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "lowCostCarrier" : true,
    "longCode" : "...",
    "manualTicketingOnly" : true,
    "airTicketsUseOrigIssueDate" : true,
    "mcoTicketsUseOrigIssueDate" : true,
    "minDomesticValue" : 12345,
    "minIntlValue" : 12345,
    "position" : 12345,
    "imageUrl" : "...",
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /contracts/getClientCarContractsById/{clientId}

Gets the CarClientContract objects for this client for car vendor contracts.

Request Parameters
name type description constraints
clientId path The client id to get the ClientContract for. long
Response Body
media type data type description
application/json array of CarClientContract (JSON) A list of CarClientContracts for the given clientId
application/xml list of carClientContract (XML)

Example

Request
GET /contracts/getClientCarContractsById/{clientId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "vendor" : {
    "longCode" : "...",
    "commissionRate" : 12345.0,
    "position" : 12345,
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "billingId" : "...",
  "insuranceIncluded" : true,
  "fileLocation" : "...",
  "favorite" : true,
  "supplementalInstructions" : "...",
  "billingIsCorpDiscount" : true,
  "ignored" : true,
  "override" : true,
  "contactName" : "...",
  "ext" : "...",
  "contactPhone" : "...",
  "contactEmail" : "...",
  "contractUrls" : [ {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "url" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /contracts/getClientContracts/{clientId}

Gets all of the ClientContracts of all types, including AirClient, CarClient, etc., for this client

Request Parameters
name type description constraints
clientId path The client id to get the ClientContracts for. long
Response Body
media type data type description
application/json array of SimpleClientContract (JSON) A list of SimpleClientContracts that are associated with the given client id.
application/xml list of simpleClientContract (XML)

Example

Request
GET /contracts/getClientContracts/{clientId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "id" : 12345,
  "name" : "...",
  "favorite" : true,
  "accountNumber" : "...",
  "expirationDate" : 12345,
  "type" : "...",
  "contractLocation" : "...",
  "rate" : 12345.0,
  "rateCode" : "...",
  "propertyCode" : "...",
  "billingId" : "...",
  "notes" : "...",
  "insuranceIncluded" : true,
  "travelType" : "..."
} ]
                
              

GET /contracts/getClientHotelChainContractsById/{clientId}

Gets the HotelChainClientContract objects for this client for hotel chain vendor contracts.

Request Parameters
name type description constraints
clientId path The client id to get the ClientContract for. long
Response Body
media type data type description
application/json array of HotelChainClientContract (JSON) A list of HotelChainClientContracts for the given clientId
application/xml list of hotelChainClientContract (XML)

Example

Request
GET /contracts/getClientHotelChainContractsById/{clientId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "vendor" : {
    "longCode" : "...",
    "commissionRate" : 12345.0,
    "family" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "position" : 12345,
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "favorite" : true,
  "family" : true,
  "code" : "...",
  "type" : "...",
  "fileLocation" : "...",
  "expirationDate" : 12345,
  "ignored" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /contracts/getClientHotelContractsById/{clientId}

Gets the HotelClientContract objects for this client for hotel vendor contracts.

Request Parameters
name type description constraints
clientId path The client id to get the ClientContract for. long
Response Body
media type data type description
application/json array of HotelClientContract (JSON) A list of HotelrClientContracts for the given clientId
application/xml list of hotelClientContract (XML)

Example

Request
GET /contracts/getClientHotelContractsById/{clientId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "hotel" : {
    "address1" : "...",
    "address2" : "...",
    "phone1" : "...",
    "phone2" : "...",
    "fax" : "...",
    "zip" : "...",
    "city" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "vendor" : {
      "longCode" : "...",
      "commissionRate" : 12345.0,
      "family" : { },
      "position" : 12345,
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "latitude" : 12345.0,
    "sertifiCode" : "...",
    "longitude" : 12345.0,
    "propertyName" : "...",
    "propertyCodes" : [ {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "type" : "...",
  "favorite" : true,
  "expirationDate" : 12345,
  "loadedDate" : 12345,
  "contactName" : "...",
  "contactPhone" : "...",
  "ext" : "...",
  "contactEmail" : "...",
  "fileLocation" : "...",
  "rate" : 12345.0,
  "code" : "...",
  "ignored" : true,
  "supplementalInstructions" : "...",
  "override" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /contracts/getClientOtherContractsById/{clientId}

Gets the ClientContract objects for this client for misc vendor contracts.

Request Parameters
name type description constraints
clientId path The client id to get the ClientContract for. long
Response Body
media type data type description
application/json array of ClientContract (JSON) A list of ClientContracts that are associated with the given client id.
application/xml list of clientContract (XML)

Example

Request
GET /contracts/getClientOtherContractsById/{clientId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "favorite" : true,
  "expirationDate" : 12345,
  "type" : "...",
  "contractLocation" : "...",
  "travelType" : {
    "travelType" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ignored" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
} ]
                
              

GET /contracts/getContractById/{clientId}

Gets the ClientContract object by it's unique id.

Request Parameters
name type description constraints
contract_id path The contract id of the contract. long
Response Body
media type data type description
application/json ClientContract (JSON) The ClientContract object associated by given id
application/xml clientContract (XML)

Example

Request
GET /contracts/getContractById/{clientId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "favorite" : true,
  "expirationDate" : 12345,
  "type" : "...",
  "contractLocation" : "...",
  "travelType" : {
    "travelType" : "...",
    "code" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "ignored" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /contracts/getExpiringClientContracts/{clientId}

Gets all of the Expiring ClientContracts of all types, including AirClient, HotelClient, etc., for this client

Request Parameters
name type description constraints
clientId path The client id to get the ClientContracts for. long
Response Body
media type data type description
application/json array of DisplayName (JSON) A list of DisplayName objects that are associated with the given client id.
application/xml list of displayName (XML)

Example

Request
GET /contracts/getExpiringClientContracts/{clientId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "id" : "...",
  "name" : "..."
} ]
                
              

GET /contracts/getHotelChainContractById/{contract_id}

Gets the HotelChainClientContract object by its unique id.

Request Parameters
name type description constraints
contract_id path The contract id of the contract. long
Response Body
media type data type description
application/json HotelChainClientContract (JSON) The HotelChainClientContract object associated by given id
application/xml hotelChainClientContract (XML)

Example

Request
GET /contracts/getHotelChainContractById/{contract_id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "vendor" : {
    "longCode" : "...",
    "commissionRate" : 12345.0,
    "family" : {
      "name" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "position" : 12345,
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "favorite" : true,
  "family" : true,
  "code" : "...",
  "type" : "...",
  "fileLocation" : "...",
  "expirationDate" : 12345,
  "ignored" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

GET /contracts/getHotelContractById/{contract_id}

Gets the HotelClientContract object by it's unique id.

Request Parameters
name type description constraints
contract_id path The contract id of the contract. long
Response Body
media type data type description
application/json HotelClientContract (JSON) The HotelClientContract object associated by given id
application/xml hotelClientContract (XML)

Example

Request
GET /contracts/getHotelContractById/{contract_id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "hotel" : {
    "address1" : "...",
    "address2" : "...",
    "phone1" : "...",
    "phone2" : "...",
    "fax" : "...",
    "zip" : "...",
    "city" : {
      "code" : "...",
      "countryCode" : "...",
      "latitude" : 12345.0,
      "longitude" : 12345.0,
      "name" : "...",
      "stateOrCountry" : "...",
      "airportName" : "...",
      "region" : { },
      "timeZone" : { },
      "retentionOnly" : true,
      "position" : 12345,
      "unique" : true,
      "alias" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "vendor" : {
      "longCode" : "...",
      "commissionRate" : 12345.0,
      "family" : { },
      "position" : 12345,
      "code" : "...",
      "name" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "latitude" : 12345.0,
    "sertifiCode" : "...",
    "longitude" : 12345.0,
    "propertyName" : "...",
    "propertyCodes" : [ {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "gds" : { },
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "type" : "...",
  "favorite" : true,
  "expirationDate" : 12345,
  "loadedDate" : 12345,
  "contactName" : "...",
  "contactPhone" : "...",
  "ext" : "...",
  "contactEmail" : "...",
  "fileLocation" : "...",
  "rate" : 12345.0,
  "code" : "...",
  "ignored" : true,
  "supplementalInstructions" : "...",
  "override" : true,
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "notes" : "...",
  "accountNumber" : "...",
  "name" : "...",
  "chain" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "preferred" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}
                
              

POST /contracts/setClientContractAsFavorite/{type}/{favorite}

A function to update client vendor contracts as a favorite or not. This is used in REST.

Request Parameters
name type description
favorite path Whether the contract should be set asa s favorite. 'true' will set the contract as a favorite.
type path The type of contract. H/C/A are accepted, sending anything else will result in it being a MISC contract.
Request Body
media type data type description
application/json number (JSON) Id of the contract in question.
application/xml long (XML)

Example

Request
POST /contracts/setClientContractAsFavorite/{type}/{favorite}
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 201 Created