REL documentation
properties apicredential (http://api.3plcentral.com/rels/properties/apicredential)
Resource:
an api credential, specific to one tpl
C# Rel Const:
Rels.PropertySvc.ApiCredential
URI template:
api/credentials/{id}
Obtain URI from:
Get a client registration
Success status: 200; ETag response header supplied; Response is cacheable
Name (* = required) Data Type Description
id * int client registration id
Type Description
Description string
ClientId string
ClientSecret string
HostName string
CustomerId int? ...
ClientCredentialId int
Roles string
DisabledByTpl bool
DisabledBySysAdmin bool
Links IList<WebApi.Hal.Link>
- edit
Sample accept: application/hal+json
{
  "description": "str",
  "clientId": "str",
  "clientSecret": "str",
  "hostName": "str",
  "customerId": 1,
  "clientCredentialId": 5,
  "roles": "str",
  "disabledByTpl": true,
  "disabledBySysAdmin": true
}
Update an existing client registration
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int client registration id
the client registration to be updated
Type Description
Description string
ClientId string
ClientSecret string
HostName string
CustomerId int? ...
ClientCredentialId int
Roles string
DisabledByTpl bool
DisabledBySysAdmin bool
Sample content-type: application/hal+json
 
{
  "description": "str",
  "clientId": "str",
  "clientSecret": "str",
  "hostName": "str",
  "customerId": 1,
  "clientCredentialId": 5,
  "roles": "str",
  "disabledByTpl": true,
  "disabledBySysAdmin": true
}
Type Description
Description string
ClientId string
ClientSecret string
HostName string
CustomerId int? ...
ClientCredentialId int
Roles string
DisabledByTpl bool
DisabledBySysAdmin bool
Links IList<WebApi.Hal.Link>
- edit
Sample accept: application/hal+json
{
  "description": "str",
  "clientId": "str",
  "clientSecret": "str",
  "hostName": "str",
  "customerId": 1,
  "clientCredentialId": 5,
  "roles": "str",
  "disabledByTpl": true,
  "disabledBySysAdmin": true
}
Delete a client registration
If-Match request header required; Success status: 204
Name (* = required) Data Type Description
id * int client registration 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.