Developer Guide

Package Groups

Add package group

URL

GET https://api.billagain.com/v1/packagegroups

OUTPUT PARAMETERS (2 Fields)

Parameter Format Description
packageGroupID Numeric Package group name
GroupName Alpha Numeric Package group name

EXAMPLES

JSON Output

HTTP CODE: 200 OK
  {
    "packageGroupID": 10104,
    "GroupName": "Cheap Items"
  },
  {
    "packageGroupID": 10105,
    "GroupName": "Expensive Group"
  }
]

Add package group

URL

GET https://api.billagain.com/v1/packagegroups/{packageGroupID}

URL PARAMETERS (1 Field)

Parameter Format Description
packageGroupID req Numeric Unique Package Group identifier

OUTPUT PARAMETERS (2 Fields)

Parameter Format Description
packageGroupID Numeric Package group name
GroupName Alpha Numeric Package group name

EXAMPLES

JSON Output

HTTP CODE: 200 OK
{
  "packageGroupID": 10104,
  "GroupName": "Cheap Items"
}

Add package group

URL

POST https://api.billagain.com/v1/packagegroups

INPUT PARAMETERS (1 Field)

Parameter Format Description
GroupName req Alpha Numeric Package group name

OUTPUT PARAMETERS (2 Fields)

Parameter Format Description
packageGroupID Numeric Package group name
GroupName Alpha Numeric Package group name

EXAMPLES

JSON Input

{
    "GroupName":"Crazy Package"
}

JSON Output

HTTP CODE: 201 Created
{
  "packageGroupID": 97,
  "GroupName": "Crazy Package"
}

Edit package group

URL

PUT https://api.billagain.com/v1/packagegroups/{packageGroupID}

URL PARAMETERS (1 Field)

Parameter Format Description
packageGroupID req Numeric Unique package group identifier

INPUT PARAMETERS (1 Field)

Parameter Format Description
GroupName req Alpha Numeric Package group name

EXAMPLES

JSON Input

{
    "GroupName":"Crazy Package"
}

JSON Output

HTTP CODE: 204 No Content

Delete package group

URL

DELETE https://api.billagain.com/v1/packagegroups/{packageGroupID}

URL PARAMETERS (1 Field)

Parameter Format Description
packageGroupID req Numeric Unique package group identifier

EXAMPLES

JSON Output

HTTP CODE: 204 No Content