master apicredential (http://api.3plcentral.com/rels/master/apicredential)
Resource:
an api credential, either specific to one tpl or not
C# Rel Const:
Rels.MasterSvc.ApiCredential
URI template:
api/credentials/{id}
Obtain URI from:
Get a single api credential
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int api credential id
Type Description
ApiCredentialId int ignored on POST and PUT
Description string
ClientId string ignored on PUT
ClientSecret string ignored on PUT
HostName string ignored on PUT
ThreePlIdentifier Generic.Models.ThreePlIdentifier ignored on PUT; name may include threepl record status
Guid string
Name string
Id int
CustomerIdentifier Generic.Models.CustomerIdentifier ignored on PUT; absent if threepl is deactivated
ExternalId string
Name string
Id int
Roles string
DisabledByTpl bool
DisabledBySysAdmin bool
CreationDate DateTime? ... ignored on PUT
UserIdentifier Generic.Models.UserIdentifier absent if threepl is deactivated
Name string
Id int
Developer string
Platform string
Notes string
Sample accept: application/hal+json
{
  "apiCredentialId": 1,
  "description": "str",
  "clientId": "str",
  "clientSecret": "str",
  "hostName": "str",
  "threePlIdentifier": {
    "guid": "str",
    "name": "str",
    "id": 3
  },
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "roles": "str",
  "disabledByTpl": true,
  "disabledBySysAdmin": true,
  "creationDate": "2016-12-25T23:00:00",
  "userIdentifier": {
    "name": "str",
    "id": 2
  },
  "developer": "str",
  "platform": "str",
  "notes": "str"
}
update an api credential
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int api credential id
Type Description
ApiCredentialId int ignored on POST and PUT
Description string
ClientId string ignored on PUT
ClientSecret string ignored on PUT
HostName string ignored on PUT
ThreePlIdentifier Generic.Models.ThreePlIdentifier ignored on PUT; name may include threepl record status
Guid string
Name string
Id int
CustomerIdentifier Generic.Models.CustomerIdentifier ignored on PUT; absent if threepl is deactivated
ExternalId string
Name string
Id int
Roles string
DisabledByTpl bool
DisabledBySysAdmin bool
CreationDate DateTime? ... ignored on PUT
UserIdentifier Generic.Models.UserIdentifier absent if threepl is deactivated
Name string
Id int
Developer string
Platform string
Notes string
Sample content-type: application/hal+json
{
  "apiCredentialId": 1,
  "description": "str",
  "clientId": "str",
  "clientSecret": "str",
  "hostName": "str",
  "threePlIdentifier": {
    "guid": "str",
    "name": "str",
    "id": 3
  },
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "roles": "str",
  "disabledByTpl": true,
  "disabledBySysAdmin": true,
  "creationDate": "2016-12-25T23:00:00",
  "userIdentifier": {
    "name": "str",
    "id": 2
  },
  "developer": "str",
  "platform": "str",
  "notes": "str"
}
Type Description
ApiCredentialId int ignored on POST and PUT
Description string
ClientId string ignored on PUT
ClientSecret string ignored on PUT
HostName string ignored on PUT
ThreePlIdentifier Generic.Models.ThreePlIdentifier ignored on PUT; name may include threepl record status
Guid string
Name string
Id int
CustomerIdentifier Generic.Models.CustomerIdentifier ignored on PUT; absent if threepl is deactivated
ExternalId string
Name string
Id int
Roles string
DisabledByTpl bool
DisabledBySysAdmin bool
CreationDate DateTime? ... ignored on PUT
UserIdentifier Generic.Models.UserIdentifier absent if threepl is deactivated
Name string
Id int
Developer string
Platform string
Notes string
Sample accept: application/hal+json
{
  "apiCredentialId": 1,
  "description": "str",
  "clientId": "str",
  "clientSecret": "str",
  "hostName": "str",
  "threePlIdentifier": {
    "guid": "str",
    "name": "str",
    "id": 3
  },
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "roles": "str",
  "disabledByTpl": true,
  "disabledBySysAdmin": true,
  "creationDate": "2016-12-25T23:00:00",
  "userIdentifier": {
    "name": "str",
    "id": 2
  },
  "developer": "str",
  "platform": "str",
  "notes": "str"
}
delete an api credential
If-Match request header required; Success status: 204
Name (* = required) Data Type Description
id * int api credential id

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.