Rel doc - Rel

GET

/master/api/credentials{?pgsiz,pgnum,rql,sort}

Get a list of api credentials
Success status: 200

Params
Response body (Master.Models.ApiCredentialList)

Name	Data Type	Description
pgsiz	int	max records to return per response; use "next" or "prev" link to paginate
pgnum	int	considering pgsiz, returns the pgnum-th page, 1-indexed
rql	string	see RQL documentation
sort	string	see RQL documentation

	Type	Description
TotalResults	int
ResourceList	IList<Master.Models.ApiCredential>
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
Links	IList<WebApi.Hal.Link>
	- edit
Links	IList<WebApi.Hal.Link>
	- next
	- prev

Sample accept: application/hal+json

{
  "totalResults": 1,
  "_embedded": {
    "http://api.3plCentral.com/rels/master/apicredential": [
      {
        "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"
      }
    ]
  }
}

POST

/master/api/credentials

Create a new api credential
Success status: 201; ETag response header supplied

none

	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
Links	IList<WebApi.Hal.Link>
	- edit

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"
}

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.