Rel doc - Rel

GET

Get all client registrations specific to the authenticated user's ThreePl
Success status: 200; Response is cacheable

Params
Response body (Property.Models.ClientCredentialList)

none

	Type	Description
TotalResults	int
ResourceList	IList<Property.Models.ClientCredential>
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

{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/properties/apicredential": [
      {
        "description": "str",
        "clientId": "str",
        "clientSecret": "str",
        "hostName": "str",
        "customerId": 1,
        "clientCredentialId": 5,
        "roles": "str",
        "disabledByTpl": true,
        "disabledBySysAdmin": true
      }
    ]
  }
}

POST

/properties/api/credentials

Create a new client registration
Success status: 201; ETag response header supplied

none

the client registration to be created

	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
}

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.