Client Operations

Credential Warning

Note: Sys Admin or Client Admin account permissions required to execute client operations. Sys Admin have full control over clients Client Admin can only administer their client

/AppSpiderEnterprise/rest/v1/Client/GetClients

Description

Retrieves a list of clients. Sys Admins will see all clients. Client Admin will only see their clients

Parameters

No parameters

Response Messages

Response Status CodeReasonDescription
200SuccessResponse contains the list of clients

Response example:

{ "type": "object", "properties": { "Clients": { "type": "array", "items": [ { "type": "object", "properties": { "ClientId": { "type": "string" }, "ClientName": { "type": "string" } }, "required": [ "ClientId", "ClientName" ] } ] }, "IsSuccess": { "type": "boolean" }, "Reason": { "type": "null" }, "ErrorMessage": { "type": "null" }, "Links": { "type": "array", "items": [ { "type": "object", "properties": { "Rel": { "type": "string" }, "Href": { "type": "string" } }, "required": [ "Rel", "Href" ] } ] } }, "required": [ "Clients", "IsSuccess", "Reason", "ErrorMessage", "Links" ] }

/AppSpiderEnterprise/rest/v1/Client/GetClient?clientName=<insert clientname>

Description

Retrieves a client based on it’s name.

Parameters

NameTypeRequiredDescription
clientNamestringYThe name of the client

Response Messages

Response Status CodeReasonDescription
200Client found
400Required parameters not provided
400NotFoundNo Client Found

Response example:

{ "type": "object", "properties": { "Client": { "type": "object", "properties": { "ClientId": { "type": "string" }, "ClientName": { "type": "string" }, "LoweredClientName": { "type": "string" }, "Address": { "type": "null" }, "Email": { "type": "string" }, "Phone": { "type": "null" }, "Mobile": { "type": "null" }, "Notes": { "type": "null" }, "DefaultTimeZone": { "type": "string" }, "DefendEnabled": { "type": "boolean" }, "EnhancedServices": { "type": "boolean" } }, "required": [ "ClientId", "ClientName", "LoweredClientName", "Address", "Email", "Phone", "Mobile", "Notes", "DefaultTimeZone", "DefendEnabled", "EnhancedServices" ] }, "IsSuccess": { "type": "boolean" }, "Reason": { "type": "null" }, "ErrorMessage": { "type": "null" }, "Links": { "type": "array", "items": [ { "type": "object", "properties": { "Rel": { "type": "string" }, "Href": { "type": "string" } }, "required": [ "Rel", "Href" ] } ] } }, "required": [ "Client", "IsSuccess", "Reason", "ErrorMessage", "Links" ] }

/AppSpiderEnterprise/rest/v1/Client/GetClient?clientId=<insert clientid>

Description

Retrieves a client based on it’s Id.

Parameters

NameTypeRequiredDescription
clientIdguidYClient Id

Response Messages

Response status codeReasonDescription
200Client found
400InvalidJsonSchemaRequired parameters not provided
400NotFoundNo Client Found

Response example:

{ "type": "object", "properties": { "Client": { "type": "object", "properties": { "ClientId": { "type": "string" }, "ClientName": { "type": "string" }, "LoweredClientName": { "type": "string" }, "Address": { "type": "null" }, "Email": { "type": "string" }, "Phone": { "type": "null" }, "Mobile": { "type": "null" }, "Notes": { "type": "null" }, "DefaultTimeZone": { "type": "string" }, "DefendEnabled": { "type": "boolean" }, "EnhancedServices": { "type": "boolean" } }, "required": [ "ClientId", "ClientName", "LoweredClientName", "Address", "Email", "Phone", "Mobile", "Notes", "DefaultTimeZone", "DefendEnabled", "EnhancedServices" ] }, "IsSuccess": { "type": "boolean" }, "Reason": { "type": "null" }, "ErrorMessage": { "type": "null" }, "Links": { "type": "array", "items": [ { "type": "object", "properties": { "Rel": { "type": "string" }, "Href": { "type": "string" } }, "required": [ "Rel", "Href" ] } ] } }, "required": [ "Client", "IsSuccess", "Reason", "ErrorMessage", "Links" ] }

/AppSpiderEnterprise/rest/v1/Client/GetClientAccounts?clientId=<insert clientid>

Description

Retrieves a list of a client’s accounts

Parameters

NameTypeRequiredDescription
clientIdguidYClient Id

Response Messages

Response status codeReasonDescription
200Client found
400Required parameters not provided
400NotFoundNo Client Accounts Found

Response example:

{ "type": "object", "properties": { "Accounts": { "type": "array", "items": [ { "type": "object", "properties": { "UserId": { "type": "string" }, "UserName": { "type": "string" }, "ClientId": { "type": "string" } }, "required": [ "UserId", "UserName", "ClientId" ] } ] }, "IsSuccess": { "type": "boolean" }, "Reason": { "type": "null" }, "ErrorMessage": { "type": "null" }, "Links": { "type": "array", "items": [ { "type": "object", "properties": { "Rel": { "type": "string" }, "Href": { "type": "string" } }, "required": [ "Rel", "Href" ] } ] } }, "required": [ "Accounts", "IsSuccess", "Reason", "ErrorMessage", "Links" ] }