Get policy

API reference

Policy

Get policy

Request

This endpoint gets a policy by ID.

Security

Bearer

Path

companyIdstring, (uuid)required

Identifier for company.

Example:4974a66b-7493-4f41-908c-58ba81093947

policyIdstring, (uuid)required

Identifier for policy.

Example:4974a66b-7493-4f41-908c-58ba81093947

curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/companies/4974a66b-7493-4f41-908c-58ba81093947/policies/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

namestringrequired

Name of the policy.

typestring(PolicyType)required

Policy type.

Enum:"DEFAULT""GROUP""INTERNAL"

Example:"GROUP"

parentPolicyIdstring, (uuid)

Policy to inherit the values of linked rules. If empty, consider the company default policy.

Example:"f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b"

currencyCurrencyCodeWrapper (object) or IsLinkedWrapper (object)(PolicyCurrency)required

One of:

Currency for the policy.

inPolicyApprovalInfosArray of objects(PolicyApprovalInfo)

outOfPolicyApprovalInfosArray of objects(PolicyApprovalInfo)

outOfPolicyAgentApprovalInfosArray of objects(PolicyApprovalInfo)

enableAgentActionOverrideboolean

True if agent can override the PREVENT_BOOKING action. If enabled, outOfPolicyAgentApprovalInfos for all travel types should be provided.

userGroupsArray of objects(UserGroup)required

commonPolicyRulesobject(CommonPolicyRules)

Details of policy that is common to all travel type.

carPolicyRulesobject(CarPolicyRules)

Details of rules related to car.

hotelPolicyRulesobject(HotelPolicyRules)

Details of rules related to hotel.

airPolicyRulesobject(AirPolicyRules)

Details of rules related to air.

rulesArray of objects(UniversalRule)

A list of general policy rules for all travel types air, hotel, car and rail.

airOopReasonCodesOopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object)(OopReasonCodes)

One of:

Out of policy reason code question to be asked to user for air booking.

hotelOopReasonCodesOopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object)(OopReasonCodes)

One of:

Out of policy reason code question to be asked to user for hotel booking.

carOopReasonCodesOopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object)(OopReasonCodes)

One of:

Out of policy reason code question to be asked to user for car booking.

railOopReasonCodesOopReasonCodesPropsWrapper (object) or IsLinkedWrapper (object)(OopReasonCodes)

One of:

Out of policy reason code question to be asked to user for rail booking.

categorystring(PolicyCategory)

Category of the policy.

Default:"EMPLOYEE"

Enum:"EMPLOYEE""GUEST"

Example:"EMPLOYEE"

idstring, (uuid)required

Example:"4974a66b-7493-4f41-908c-58ba81093947"

versioninteger, (int32)

updatedAtobject(DateTimeOffset)

ISO8601 UTC Date Time

isMembershipViaHrFeedboolean

True if membership is via HR feed. Read-only.

Example:true

hrFeedPolicyDetailsobject(User Group Via Hr Feed Details.)

User group details if membership is via HR feed. Read-only.

inPolicyApprovalInfoobject(PolicyApprovalInfo)deprecated

outOfPolicyApprovalInfoobject(PolicyApprovalInfo)deprecated

isRestrictivebooleandeprecated

True if policy is a restrictive policy.

Example:true

Response

{
  "id": "4974a66b-7493-4f41-908c-58ba81093947",
  "version": 0,
  "updatedAt": {
    "iso8601": "2017-07-21T17:32Z"
  },
  "isMembershipViaHrFeed": true,
  "hrFeedPolicyDetails": {
    "totalMemberCount": 0
  },
  "name": "string",
  "type": "GROUP",
  "parentPolicyId": "f7b3b3b3-7b3b-4b3b-8b3b-3b3b3b3b3b3b",
  "currency": {
    "currencyCode": "USD"
  },
  "inPolicyApprovalInfo": {
    "approvalProcessType": "NONE",
    "designatedApprovers": [ … ],
    "isManagerApprover": false,
    "isEmployeeLevelDesignatedApprover": false,
    "shouldNotifyManager": false,
    "travelTypes": [ … ],
    "approvalConditions": [ … ],
    "defaultApprovers": [ … ]
  },
  "outOfPolicyApprovalInfo": {
    "approvalProcessType": "NONE",
    "designatedApprovers": [ … ],
    "isManagerApprover": false,
    "isEmployeeLevelDesignatedApprover": false,
    "shouldNotifyManager": false,
    "travelTypes": [ … ],
    "approvalConditions": [ … ],
    "defaultApprovers": [ … ]
  },
  "inPolicyApprovalInfos": [
    { … }
  ],
  "outOfPolicyApprovalInfos": [
    { … }
  ],
  "outOfPolicyAgentApprovalInfos": [
    { … }
  ],
  "enableAgentActionOverride": true,
  "userGroups": [
    { … }
  ],
  "commonPolicyRules": {
    "restrictedContinents": { … },
    "restrictedCountries": { … }
  },
  "carPolicyRules": {
    "maxCarPricePerNumberOfDays": { … },
    "allowedCarTypes": { … }
  },
  "hotelPolicyRules": {
    "restrictedHotels": { … },
    "maxHotelPriceByLocation": { … },
    "hotelAdvanceBookingWindow": { … },
    "hotelCancellation": { … },
    "hotelChainCodes": { … },
    "hotelStarRating": { … },
    "hotelMedianRateNightly": { … },
    "hotelCentralTierExemption": { … }
  },
  "airPolicyRules": {
    "restrictedAirlines": { … },
    "restrictedAirCrafts": { … },
    "maxFlightBookingPriceByDuration": { … },
    "flightCabinUpgrade": { … },
    "flightAdvanceBookingWindow": { … },
    "flightTicketsRefundable": { … },
    "flightTicketsChangeable": { … },
    "highestFlightCabinByDurationDomestic": { … },
    "highestFlightCabinByDurationInternational": { … },
    "highestFlightCabinOvernight": { … },
    "differenceBetweenFlightFareAndMedianFare": { … },
    "co2EmissionPerPassengerPerKm": { … },
    "maxFlightBookingPriceInternational": { … },
    "maxFlightBookingPriceDomestic": { … },
    "lowestLogicalFare": { … }
  },
  "isRestrictive": true,
  "rules": [
    { … }
  ],
  "airOopReasonCodes": {
    "props": { … }
  },
  "hotelOopReasonCodes": {
    "props": { … }
  },
  "carOopReasonCodes": {
    "props": { … }
  },
  "railOopReasonCodes": {
    "props": { … }
  },
  "category": "EMPLOYEE"
}