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

get

/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 Code

Reason

Description

200

Success

Response contains the list of clients

Response example:

JSON schema:
1
{
2
  "type": "object",
3
  "properties": {
4
    "Clients": {
5
      "type": "array",
6
      "items": [
7
        {
8
          "type": "object",
9
          "properties": {
10
            "ClientId": {
11
              "type": "string"
12
            },
13
            "ClientName": {
14
              "type": "string"
15
            }
16
          },
17
          "required": [
18
            "ClientId",
19
            "ClientName"
20
          ]
21
        }
22
      ]
23
    },
24
    "IsSuccess": {
25
      "type": "boolean"
26
    },
27
    "Reason": {
28
      "type": "null"
29
    },
30
    "ErrorMessage": {
31
      "type": "null"
32
    },
33
    "Links": {
34
      "type": "array",
35
      "items": [
36
        {
37
          "type": "object",
38
          "properties": {
39
            "Rel": {
40
              "type": "string"
41
            },
42
            "Href": {
43
              "type": "string"
44
            }
45
          },
46
          "required": [
47
            "Rel",
48
            "Href"
49
          ]
50
        }
51
      ]
52
    }
53
  },
54
  "required": [
55
    "Clients",
56
    "IsSuccess",
57
    "Reason",
58
    "ErrorMessage",
59
    "Links"
60
  ]
61
}
get

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

Description

Retrieves a client based on it's name.

Parameters

Name

Type

Required

Description

clientName

string

Y

The name of the client

Response Messages

Response Status Code

Reason

Description

200

Client found

400

Required parameters not provided

400

NotFound

No Client Found

Response example:

JSON schema:
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Client": {
5
      "type": "object",
6
      "properties": {
7
        "ClientId": {
8
          "type": "string"
9
        },
10
        "ClientName": {
11
          "type": "string"
12
        },
13
        "LoweredClientName": {
14
          "type": "string"
15
        },
16
        "Address": {
17
          "type": "null"
18
        },
19
        "Email": {
20
          "type": "string"
21
        },
22
        "Phone": {
23
          "type": "null"
24
        },
25
        "Mobile": {
26
          "type": "null"
27
        },
28
        "Notes": {
29
          "type": "null"
30
        },
31
        "DefaultTimeZone": {
32
          "type": "string"
33
        },
34
        "DefendEnabled": {
35
          "type": "boolean"
36
        },
37
        "EnhancedServices": {
38
          "type": "boolean"
39
        }
40
      },
41
      "required": [
42
        "ClientId",
43
        "ClientName",
44
        "LoweredClientName",
45
        "Address",
46
        "Email",
47
        "Phone",
48
        "Mobile",
49
        "Notes",
50
        "DefaultTimeZone",
51
        "DefendEnabled",
52
        "EnhancedServices"
53
      ]
54
    },
55
    "IsSuccess": {
56
      "type": "boolean"
57
    },
58
    "Reason": {
59
      "type": "null"
60
    },
61
    "ErrorMessage": {
62
      "type": "null"
63
    },
64
    "Links": {
65
      "type": "array",
66
      "items": [
67
        {
68
          "type": "object",
69
          "properties": {
70
            "Rel": {
71
              "type": "string"
72
            },
73
            "Href": {
74
              "type": "string"
75
            }
76
          },
77
          "required": [
78
            "Rel",
79
            "Href"
80
          ]
81
        }
82
      ]
83
    }
84
  },
85
  "required": [
86
    "Client",
87
    "IsSuccess",
88
    "Reason",
89
    "ErrorMessage",
90
    "Links"
91
  ]
92
}
get

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

Description

Retrieves a client based on it's Id.

Parameters

Name

Type

Required

Description

clientId

guid

Y

Client Id

Response Messages

Response status code

Reason

Description

200

Client found

400

InvalidJsonSchema

Required parameters not provided

400

NotFound

No Client Found

Response example:

JSON schema:
1
{
2
  "type": "object",
3
  "properties": {
4
    "Client": {
5
      "type": "object",
6
      "properties": {
7
        "ClientId": {
8
          "type": "string"
9
        },
10
        "ClientName": {
11
          "type": "string"
12
        },
13
        "LoweredClientName": {
14
          "type": "string"
15
        },
16
        "Address": {
17
          "type": "null"
18
        },
19
        "Email": {
20
          "type": "string"
21
        },
22
        "Phone": {
23
          "type": "null"
24
        },
25
        "Mobile": {
26
          "type": "null"
27
        },
28
        "Notes": {
29
          "type": "null"
30
        },
31
        "DefaultTimeZone": {
32
          "type": "string"
33
        },
34
        "DefendEnabled": {
35
          "type": "boolean"
36
        },
37
        "EnhancedServices": {
38
          "type": "boolean"
39
        }
40
      },
41
      "required": [
42
        "ClientId",
43
        "ClientName",
44
        "LoweredClientName",
45
        "Address",
46
        "Email",
47
        "Phone",
48
        "Mobile",
49
        "Notes",
50
        "DefaultTimeZone",
51
        "DefendEnabled",
52
        "EnhancedServices"
53
      ]
54
    },
55
    "IsSuccess": {
56
      "type": "boolean"
57
    },
58
    "Reason": {
59
      "type": "null"
60
    },
61
    "ErrorMessage": {
62
      "type": "null"
63
    },
64
    "Links": {
65
      "type": "array",
66
      "items": [
67
        {
68
          "type": "object",
69
          "properties": {
70
            "Rel": {
71
              "type": "string"
72
            },
73
            "Href": {
74
              "type": "string"
75
            }
76
          },
77
          "required": [
78
            "Rel",
79
            "Href"
80
          ]
81
        }
82
      ]
83
    }
84
  },
85
  "required": [
86
    "Client",
87
    "IsSuccess",
88
    "Reason",
89
    "ErrorMessage",
90
    "Links"
91
  ]
92
}
get

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

Description

Retrieves a list of a client's accounts

Parameters

Name

Type

Required

Description

clientId

guid

Y

Client Id

Response Messages

Response status code

Reason

Description

200

Client found

400

Required parameters not provided

400

NotFound

No Client Accounts Found

Response example:

JSON schema:
1
{ 
2
  "type": "object",
3
  "properties": {
4
    "Accounts": {
5
      "type": "array",
6
      "items": [               
7
        {
8
          "type": "object",
9
          "properties": {
10
            "UserId": {
11
              "type": "string"
12
            },
13
            "UserName": {
14
              "type": "string"
15
            },
16
            "ClientId": {
17
              "type": "string"
18
            }
19
          },
20
          "required": [
21
            "UserId",
22
            "UserName",
23
            "ClientId"
24
          ]
25
        }       
26
      ]
27
    },
28
    "IsSuccess": {
29
      "type": "boolean"
30
    },
31
    "Reason": {
32
      "type": "null"
33
    },
34
    "ErrorMessage": {
35
      "type": "null"
36
    },
37
    "Links": {
38
      "type": "array",
39
      "items": [
40
        {
41
          "type": "object",
42
          "properties": {
43
            "Rel": {
44
              "type": "string"
45
            },
46
            "Href": {
47
              "type": "string"
48
            }
49
          },
50
          "required": [
51
            "Rel",
52
            "Href"
53
          ]
54
        }
55
      ]
56
    }
57
  },
58
  "required": [
59
    "Accounts",
60
    "IsSuccess",
61
    "Reason",
62
    "ErrorMessage",
63
    "Links"
64
  ]
65
}