Applied Pre-Approvals JSON API Example

apply-preapproval-preview.txt

//GET /expensereports/1/relationships/applicablepreapprovals HTTP/1.1
//Content-Type: application/vnd.api+json
//Accept: application/vnd.api+json

{
  "links": {
    "self"   : "/expensereports/1/relationships/applicablepreapprovals",
    "related": "/expensereports/1/applicablepreapprovals"
  },
  "data" : [
    {"type": "preapprovals", "id": "2"},
    {"type": "preapprovals", "id": "3"}
  ]
};

//GET /expensereports/1?include=applicablepreapprovals HTTP/1.1
//Content-Type: application/vnd.api+json
//Accept: application/vnd.api+json

{
  "links"   : {
    "self": "/expensereports/1?include=applicablepreapprovals"
  },
  "data"    : {
    "type"         : "expensereports",
    "id"           : "1",
    "attributes"   : {
      "title": "JSON API paints my bikeshed!"
    },
    "relationships": {
      "applicablepreapprovals": {
        "links": {
          "self"   : "/expensereports/1/relationships/applicablepreapprovals",
          "related": "/expensereports/1/applicablepreapprovals"
        },
        "data" : [
          {"type": "preapprovals", "id": "2"},
          {"type": "preapprovals", "id": "3"}
        ]
      }
    }
  },
  "included": [{
    "type"         : "preapprovals",
    "id"           : "2",
    "attributes"   : {
      "name": "First!"
    },
    "links"        : {
      "self": "/preapprovals/2"
    }
  }, {
    "type"         : "preapprovals",
    "id"           : "3",
    "attributes"   : {
      "name": "I like XML better"
    },
    "links"        : {
      "self": "preapprovals/3"
    }
  }]
}

//GET /expensereports/1/applicablepreapprovals HTTP/1.1
//Content-Type: application/vnd.api+json
//Accept: application/vnd.api+json

{
  "links"   : {
    "self": "/expensereports/1/applicablepreapprovals"
  },
  "data"    : [{
    "type"         : "preapprovals",
    "id"           : "2",
    "attributes"   : {
      "name": "First!"
    },
    "links"        : {
      "self": "/preapprovals/2"
    }
  }, {
    "type"         : "preapprovals",
    "id"           : "3",
    "attributes"   : {
      "name": "I like XML better"
    },
    "links"        : {
      "self": "preapprovals/3"
    }
  }]
}

//GET /preapprovals/1/applypreviews/2 HTTP/1.1
//Content-Type: application/vnd.api+json
//Accept: application/vnd.api+json

{
  "links"   : {
    "self": "/preapprovals/1/applypreviews/2"
  },
  "data"    : {
    "type"         : "applypreviews",
    "id"           : "2",
    "attributes"   : {
      "name": "test 1",
      "itemTypeTotals": [
        {
          "paExpenseTypeName": "Parking",
          "remainingBalance" : "250",
          "spentAmount"      : "100"
        },
        {
          "paExpenseTypeName": "Airfare",
          "remainingBalance" : "1250",
          "spentAmount"      : "1100"
        }
      ]
    }
  }
}

//PATCH /preapprovals/1/relationships/expensereports HTTP/1.1
//Content-Type: application/vnd.api+json
//Accept: application/vnd.api+json

{
  "data": [{
    "type": "expensereports",
    "id"  : "2"
  }, {
    "type": "expensereports",
    "id"  : "3"
  }]
};